Merge pull request #129 from mizoR/support-oauth

Support OAuth

Author: mizoR

README.md

@@ -23,7 +23,7 @@ gem 'line-bot-api'
 
 And then execute:
 
-```ruby
+```sh
 bundle
 ```
 
@@ -44,6 +44,7 @@ require 'line/bot'
 
 def client
   @client ||= Line::Bot::Client.new { |config|
+    config.channel_id = ENV["LINE_CHANNEL_ID"]
     config.channel_secret = ENV["LINE_CHANNEL_SECRET"]
     config.channel_token = ENV["LINE_CHANNEL_TOKEN"]
   }

examples/kitchensink/app.rb

@@ -9,6 +9,7 @@
 
 def client
   @client ||= Line::Bot::Client.new do |config|
+    config.channel_id = ENV["LINE_CHANNEL_ID"]
     config.channel_secret = ENV["LINE_CHANNEL_SECRET"]
     config.channel_token = ENV["LINE_CHANNEL_TOKEN"]
     config.http_options = {

lib/line/bot/client.rb

@@ -16,12 +16,13 @@
 require 'base64'
 require 'net/http'
 require 'openssl'
+require 'uri'
 
 module Line
   module Bot
     class Client
       #  @return [String]
-      attr_accessor :channel_token, :channel_secret, :endpoint
+      attr_accessor :channel_token, :channel_id, :channel_secret, :endpoint
 
       # @return [Object]
       attr_accessor :httpclient
@@ -56,6 +57,49 @@ def credentials
         }
       end
 
+      # Issue channel access token
+      #
+      # @param grant_type [String] Grant type
+      #
+      # @return [Net::HTTPResponse]
+      def issue_channel_token(grant_type = 'client_credentials')
+        channel_id_required
+        channel_secret_required
+
+        payload = URI.encode_www_form(
+          grant_type:    grant_type,
+          client_id:     channel_id,
+          client_secret: channel_secret
+        )
+
+        request = Request.new do |config|
+          config.httpclient    = httpclient
+          config.endpoint      = endpoint
+          config.endpoint_path = '/oauth/accessToken'
+          config.content_type  = 'application/x-www-form-urlencoded'
+          config.payload       = payload
+        end
+
+        request.post
+      end
+
+      # Revoke channel access token
+      #
+      # @return [Net::HTTPResponse]
+      def revoke_channel_token(access_token)
+        payload = URI.encode_www_form(access_token: access_token)
+
+        request = Request.new do |config|
+          config.httpclient    = httpclient
+          config.endpoint      = endpoint
+          config.endpoint_path = '/oauth/revoke'
+          config.content_type  = 'application/x-www-form-urlencoded'
+          config.payload       = payload
+        end
+
+        request.post
+      end
+
       # Push messages to line server and to user.
       #
       # @param user_id [String] User's identifiers
@@ -575,6 +619,14 @@ def secure_compare(a, b)
       def channel_token_required
         raise ArgumentError, '`channel_token` is not configured' unless channel_token
       end
+
+      def channel_id_required
+        raise ArgumentError, '`channel_id` is not configured' unless channel_id
+      end
+
+      def channel_secret_required
+        raise ArgumentError, '`channel_secret` is not configured' unless channel_secret
+      end
     end
   end
 end

lib/line/bot/request.rb

@@ -22,6 +22,8 @@ module Bot
     class Request
       attr_accessor :endpoint, :endpoint_path, :credentials, :to, :reply_token, :messages, :httpclient, :payload, :file
 
+      attr_writer :content_type
+
       # Initializes a new Request
       #
       # @return [Line::Bot::Request]
@@ -44,27 +46,22 @@ def payload
 
       # @return [Hash]
       def header
-        content_type =
-          if file.is_a? File
-            case file.path
-            when /\.png\z/i then 'image/png'
-            when /\.jpe?g\z/i then 'image/jpeg'
-            else
-              raise ArgumentError.new("invalid file extension: #{file.path}")
-            end
-          else
-            'application/json; charset=UTF-8'
-          end
-
         header = {
           'Content-Type' => content_type,
           'User-Agent' => "LINE-BotSDK-Ruby/#{Line::Bot::API::VERSION}",
         }
-        hash = credentials.inject({}) { |h, (k, v)| h[k] = v.to_s; h }
+        hash = (credentials || {}).inject({}) { |h, (k, v)| h[k] = v.to_s; h }
 
         header.merge(hash)
       end
 
+      # @return [String]
+      def content_type
+        return @content_type if @content_type
+
+        guess_content_type
+      end
+
       # Get content of specified URL.
       #
       # @return [Net::HTTPResponse]
@@ -99,6 +96,22 @@ def assert_for_posting_message
       def assert_for_deleting_message
         raise ArgumentError, 'Wrong argument type `endpoint_path`' unless endpoint_path.is_a?(String)
       end
+
+      private
+
+      # @return [String]
+      def guess_content_type
+        if file.is_a? File
+          case file.path
+          when /\.png\z/i then 'image/png'
+          when /\.jpe?g\z/i then 'image/jpeg'
+          else
+            raise ArgumentError.new("invalid file extension: #{file.path}")
+          end
+        else
+          'application/json; charset=UTF-8'
+        end
+      end
     end
   end
 end

spec/fixtures/line/bot/preview.jpg

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'webmock/rspec'
+require 'json'
+
+OAUTH_CHANNEL_TOKEN_ISSUE_CONTENT = <<"EOS"
+{
+    "access_token": "W1TeHCgfH2Liwaxxxxx1",
+    "expires_in": 2592000,
+    "token_type": "Bearer"
+}
+EOS
+
+WebMock.allow_net_connect!
+
+describe Line::Bot::Client do
+  def dummy_config
+    {
+      channel_id: 'channel id',
+      channel_secret: 'channel secret',
+    }
+  end
+
+  def generate_client
+    Line::Bot::Client.new do |config|
+      config.channel_id     = dummy_config[:channel_id]
+      config.channel_secret = dummy_config[:channel_secret]
+    end
+  end
+
+  it 'issues an oauth access token' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/oauth/accessToken'
+    stub_request(:post, uri_template).to_return { |request| {body: OAUTH_CHANNEL_TOKEN_ISSUE_CONTENT, status: 200} }
+
+    client = generate_client
+    response = client.issue_channel_token
+
+    expect(response).to be_a(Net::HTTPOK)
+    result = JSON.parse(response.body)
+    expect(result['access_token']).to eq 'W1TeHCgfH2Liwaxxxxx1'
+    expect(result['expires_in']).to eq 2592000
+    expect(result['token_type']).to eq 'Bearer'
+  end
+
+  it 'revokes the oauth access token' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/oauth/revoke'
+    stub_request(:post, uri_template).to_return { |request| {body: '', status: 200} }
+
+    client = generate_client
+
+    response = client.revoke_channel_token('W1TeHCgfH2Liwaxxxxx1')
+
+    expect(response).to be_a(Net::HTTPOK)
+  end
+end

spec/fixtures/line/bot/video.mp4

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Line::Bot::Request do
+  describe '#content_type' do
+    subject { request.content_type }
+
+    context 'content type is not specified' do
+      let(:request) { described_class.new }
+
+      it { is_expected.to eq 'application/json; charset=UTF-8' }
+    end
+
+    context 'content type is specified' do
+      let(:request) do
+        described_class.new do |config|
+          config.content_type = 'application/x-www-form-urlencoded'
+        end
+      end
+
+      it { is_expected.to eq 'application/x-www-form-urlencoded' }
+    end
+
+    context 'jpeg file is assigned' do
+      let(:request) do
+        described_class.new do |config|
+          config.file = File.open('spec/fixtures/line/bot/preview.jpg')
+        end
+      end
+
+      it { is_expected.to eq 'image/jpeg' }
+    end
+
+    context 'unsupported file is assigned' do
+      let(:request) do
+        described_class.new do |config|
+          config.file = File.open('spec/fixtures/line/bot/video.mp4')
+        end
+      end
+
+      it do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end