Merge branch 'master' into feature/member_join_and_leave_event

Author: kimoto

.travis.yml

@@ -4,9 +4,15 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
   - ruby-head
 before_install:
-  - gem install bundler
+  - if [ ${TRAVIS_RUBY_VERSION} = '2.2' ]; then
+      gem install bundler -v '< 2';
+    else
+      gem update --system;
+      gem install bundler;
+    fi
 script:
   - bundle exec rubocop
   - bundle exec rspec

lib/line-bot-api.rb

@@ -0,0 +1 @@
+require 'line/bot'

lib/line/bot/api/version.rb

@@ -15,7 +15,7 @@
 module Line
   module Bot
     module API
-      VERSION = "1.3.0"
+      VERSION = "1.6.0"
     end
   end
 end

lib/line/bot/client.rb

@@ -243,6 +243,36 @@ def get_rich_menu(rich_menu_id)
         get(endpoint_path)
       end
 
+      # Gets the number of messages sent with the /bot/message/reply endpoint.
+      #
+      # @param date [String] Date the messages were sent (format: yyyyMMdd)
+      #
+      # @return [Net::HTTPResponse]
+      def get_message_delivery_reply(date)
+        endpoint_path = "/bot/message/delivery/reply?date=#{date}"
+        get(endpoint_path)
+      end
+
+      # Gets the number of messages sent with the /bot/message/push endpoint.
+      #
+      # @param date [String] Date the messages were sent (format: yyyyMMdd)
+      #
+      # @return [Net::HTTPResponse]
+      def get_message_delivery_push(date)
+        endpoint_path = "/bot/message/delivery/push?date=#{date}"
+        get(endpoint_path)
+      end
+
+      # Gets the number of messages sent with the /bot/message/multicast endpoint.
+      #
+      # @param date [String] Date the messages were sent (format: yyyyMMdd)
+      #
+      # @return [Net::HTTPResponse]
+      def get_message_delivery_multicast(date)
+        endpoint_path = "/bot/message/delivery/multicast?date=#{date}"
+        get(endpoint_path)
+      end
+
       # Create a rich menu
       #
       # @param rich_menu [Hash] The rich menu represented as a rich menu object
@@ -280,6 +310,14 @@ def get_user_rich_menu(user_id)
         get(endpoint_path)
       end
 
+      # Get default rich menu
+      #
+      # @return [Net::HTTPResponse]
+      def get_default_rich_menu
+        endpoint_path = '/bot/user/all/richmenu'
+        get(endpoint_path)
+      end
+
       # Set default rich menu (Link a rich menu to all user)
       #
       # @param rich_menu_id [String] ID of an uploaded rich menu
@@ -353,6 +391,16 @@ def create_rich_menu_image(rich_menu_id, file)
         request.post
       end
 
+      # Issue a link token to a user
+      #
+      # @param user_id [String] ID of the user
+      #
+      # @return [Net::HTTPResponse]
+      def create_link_token(user_id)
+        endpoint_path = "/bot/user/#{user_id}/linkToken"
+        post(endpoint_path)
+      end
+
       # Fetch data, get content of specified URL.
       #
       # @param endpoint_path [String]
@@ -418,7 +466,7 @@ def parse_events_from(request_body)
 
         json['events'].map { |item|
           begin
-            klass = Line::Bot::Event.const_get(item['type'].capitalize)
+            klass = Line::Bot::Event.const_get(camelize(item['type']))
             klass.new(item)
           rescue NameError => e
             Line::Bot::Event::Base.new(item)
@@ -462,6 +510,11 @@ def secure_compare(a, b)
         b.each_byte { |byte| res |= byte ^ l.shift }
         res == 0
       end
+
+      # @return [String]
+      def camelize(string)
+        string.split(/_|(?=[A-Z])/).map(&:capitalize).join
+      end
     end
   end
 end

lib/line/bot/event.rb

@@ -13,6 +13,7 @@
 # under the License.
 
 require 'line/bot/event/base'
+require 'line/bot/event/account_link'
 require 'line/bot/event/beacon'
 require 'line/bot/event/follow'
 require 'line/bot/event/join'

lib/line/bot/event/account_link.rb

@@ -0,0 +1,29 @@
+# Copyright 2016 LINE
+#
+# LINE Corporation licenses this file to you under the Apache License,
+# version 2.0 (the "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+module Line
+  module Bot
+    module Event
+      class AccountLink < Base
+        def result
+          @src['link']['result']
+        end
+
+        def nonce
+          @src['link']['nonce']
+        end
+      end
+    end
+  end
+end

line-bot-api.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version     = '>= 2.0.0'
 
   spec.add_development_dependency "addressable", "~> 2.3"
-  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "bundler", "~> 1.11" if RUBY_VERSION < "2.3"
   spec.add_development_dependency 'rake', "~> 10.4"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 1.24"

spec/line/bot/client_get_spec.rb

@@ -20,6 +20,13 @@
 }
 EOS
 
+DELIVERY_NUMBER_CONTENT = <<"EOS"
+{
+  "status": "ready",
+  "success": 1
+}
+EOS
+
 WebMock.allow_net_connect!
 
 describe Line::Bot::Client do
@@ -76,4 +83,48 @@ def generate_client
     contact = JSON.parse(response.body)
     expect(contact['displayName']).to eq "Brown"
   end
+
+  it "gets the number of reply messages sent" do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/delivery/reply?date={sent_date}'
+    stub_request(:get, uri_template).to_return(body: DELIVERY_NUMBER_CONTENT, status: 200)
+
+    client = generate_client
+    response = client.get_message_delivery_reply("20190101")
+
+    delivery = JSON.parse(response.body)
+    expect(delivery['status']).to eq "ready"
+    expect(delivery['success']).to eq 1
+  end
+
+  it "gets the number of push messages sent" do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/delivery/push?date={sent_date}'
+    stub_request(:get, uri_template).to_return(body: DELIVERY_NUMBER_CONTENT, status: 200)
+
+    client = generate_client
+    response = client.get_message_delivery_push("20190101")
+
+    delivery = JSON.parse(response.body)
+    expect(delivery['status']).to eq "ready"
+    expect(delivery['success']).to eq 1
+  end
+
+  it "gets the number of multicast messages sent" do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/delivery/multicast?date={send_date}'
+    stub_request(:get, uri_template).to_return(body: DELIVERY_NUMBER_CONTENT, status: 200)
+
+    client = generate_client
+    response = client.get_message_delivery_multicast("20190101")
+
+    delivery = JSON.parse(response.body)
+    expect(delivery['status']).to eq "ready"
+    expect(delivery['success']).to eq 1
+  end
+
+  it "gets number of messages sent whithout date will raise error" do
+    client = generate_client
+
+    expect { client.get_message_delivery_reply }.to raise_error(ArgumentError)
+    expect { client.get_message_delivery_push }.to raise_error(ArgumentError)
+    expect { client.get_message_delivery_multicast }.to raise_error(ArgumentError)
+  end
 end

spec/line/bot/client_parse_spec.rb

@@ -145,6 +145,19 @@
         "type": "enter",
         "dm": "1234567890abcdef"
       }
+    },
+    {
+      "type": "accountLink",
+      "replyToken": "replyToken",
+      "source": {
+        "type": "user",
+        "userId": "userid"
+      },
+      "timestamp": 12345678901234,
+      "link": {
+        "result": "ok",
+        "nonce": "nonce"
+      }
     }
   ]
 }
@@ -251,6 +264,10 @@ def generate_client
     expect(events[11].type).to eq("enter")
     expect(events[11]['beacon']['dm']).to eq("1234567890abcdef")
     expect(events[11].deviceMessage).to eq("\x12\x34\x56\x78\x90\xab\xcd\xef".b)
+
+    expect(events[12]).to be_a(Line::Bot::Event::AccountLink)
+    expect(events[12].result).to eq("ok")
+    expect(events[12].nonce).to eq("nonce")
   end
 
   it 'parses unknown event' do

spec/line/bot/link_token_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'webmock/rspec'
+require 'json'
+
+LINK_TOKEN_CONTENT = <<"EOS"
+{
+  "linkToken":"abcdefg0123456789"
+}
+EOS
+
+WebMock.allow_net_connect!
+
+describe Line::Bot::Client do
+  let(:client) {
+    dummy_config = {
+      channel_token: 'access token',
+    }
+    Line::Bot::Client.new do |config|
+      config.channel_token = dummy_config[:channel_token]
+    end
+  }
+
+  it 'issues a link token' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/user/{user_id}/linkToken'
+    stub_request(:post, uri_template).to_return(body: LINK_TOKEN_CONTENT, status: 200)
+
+    response = client.create_link_token('user_id')
+    expect(WebMock).to have_requested(:post, Line::Bot::API::DEFAULT_ENDPOINT + '/bot/user/user_id/linkToken')
+    expect(response.body).to eq LINK_TOKEN_CONTENT
+  end
+end