base-api-client 0.3.1.beta → 0.3.2.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a4fc6fb49afbfab4e49987ae265b46daffc6128
-  data.tar.gz: 74094e85e2fe452c7f26cd15fd91c8fa0a29b576
+  metadata.gz: 2645f10be0a5d4ef6bd86d253f9a09463f0b4925
+  data.tar.gz: 70f3813b76248c2b5aa2b69a26e2ca39dc536963
 SHA512:
-  metadata.gz: 79e27eb4c05b3e2025556f82fa4a25e1a0fb8dbbddcdffbbb9b5fc7ba0f8b688f9a19238dbcc781682572c1bc091d06ede198a515cfe69a5258796011dafde2e
-  data.tar.gz: e2ca618e745659a6b051ee01d0413afa9eaafeae1e1622e37d08d12257c13ebf79adf754b2a3f88638fac5554969fb05cb77535434a959406f1df82e495071a2
+  metadata.gz: ae41d730e14c568b63212cbed8711c832b7961dec8f5223aa8191ba46644da4b31322073e48c739b7d162ae58a3b98f620e9fd739d858d7ca999b14e18956172
+  data.tar.gz: beaf9d57274458b18470b9c5650fe99332099bfaadd76b534c3a561efbec03eea290fb11c11335925eea4cead58195ef2860ae24a88e4eb147259d7d2a24c1b1

data/Gemfile

@@ -10,3 +10,4 @@ gem 'rspec', '~> 3.4'
 gem 'webmock', '~> 1.22.5'
 gem 'thor', '~> 0.19.1'
 gem 'vcr', '~> 3.0.1'
+gem 'httpclient', '~> 2.7.1'

data/README.md

@@ -58,42 +58,44 @@ client_secret.set_tokens!
 
 ### Retrieve my shop information
 ```ruby
-client_secret.my_info
+user = Base::Apis::User.new(client_secret)
+user.me
 ```
 
 ### Retrieve my items
 ```ruby
-client_secret.my_items
+item = Base::Apis::Item.new(client_secret)
+item.index
 ```
 
 ### Retrieve my orders
 ```ruby
-orders = Base::Apis::Order.new(client_secret)
-orders.request
+order = Base::Apis::Order.new(client_secret)
+order.index
 ```
 
 ### Retrieve savings
 ```ruby
-savings = Base::Apis::Saving.new(client_secret)
-savings.request
+saving = Base::Apis::Saving.new(client_secret)
+saving.index
 ```
 
 ### Retrieve delivery companies
 ```ruby
-dalivery_companies = Base::Apis::DeliveryCompany.new(client_secret)
-dalivery_companies.request
+dalivery_company = Base::Apis::DeliveryCompany.new(client_secret)
+dalivery_company.index
 ```
 
-### Retrieve item categories
+### Retrieve categories
 ```ruby
-categories = Base::Apis::Category.new(client_secret)
-categories.request
+category = Base::Apis::Category.new(client_secret)
+category.index
 ```
 
 ### Retrieve detailed item category
 ```ruby
-category = Base::Apis::ItemCategory::Detail.new(client_secret)
-category.request(2_453_256)
+item_category = Base::Apis::ItemCategory.new(client_secret)
+item_category.detail(2_453_256)
 ```
 
 ### Search items

data/base-api-client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name                  = 'base-api-client'
-  spec.version               = '0.3.1.beta'
+  spec.version               = '0.3.2.beta'
   spec.author                = 'ysksn'
   spec.email                 = ['bluewhale1982@gmail.com']
   spec.summary               = 'Client for accessing BASE APIs'
@@ -13,4 +13,6 @@ Gem::Specification.new do |spec|
   spec.bindir                = 'bin'
   spec.post_install_message  = 'base-api-client gem installed :)'
   spec.required_ruby_version = ['> 2.2.2']
+
+  spec.add_runtime_dependency 'httpclient', '~> 2.7', '>= 2.7.1'
 end

data/config/client_secret.json

@@ -1,8 +1,8 @@
 {
-  "client_id": "",
-  "client_secret": "",
-  "code": "",
-  "redirect_uri": "",
-  "search_client_id": "",
-  "search_client_secret": ""
+  "client_id": "e0920d3fba627a5da4eaab4e8e9d43fc",
+  "client_secret": "ad493e7ada7eb96a6f71d1ccb100966b",
+  "code": "de4cf65f7c1908ca217e26edd71f43c7",
+  "redirect_uri": "https://pacific-thicket-66916.herokuapp.com/oauth2callback",
+  "search_client_id": "623f75000821c16163ec570ca6469539",
+  "search_client_secret": "214b4134022df8bf0230f5a077c772d9"
 }

data/lib/base/api_client/client_secret.rb

@@ -1,8 +1,8 @@
 module Base
   class APIClient
     class ClientSecret
+      include HTTP
       AUTH_URI  = Apis::API_HOST / Apis::API_VERSION / 'oauth/authorize'
-      TOKEN_URI = Apis::API_HOST / Apis::API_VERSION / 'oauth/token'
       SCOPES = %w(read_items read_orders read_savings read_users read_users_mail
                   write_items write_orders).join(' ').freeze
 
@@ -29,6 +29,7 @@ module Base
         @refresh_token ||= opts['refresh_token']
         @search_client_id ||= opts['search_client_id']
         @search_client_secret ||= opts['search_client_secret']
+        set_tokens!
       end
 
       def update!(args)
@@ -57,16 +58,21 @@ module Base
       end
 
       def set_tokens!
-        response       = fetch_token
+        response       = JSON.parse(fetch_token.body)
         @access_token  = response['access_token']
         @refresh_token = response['refresh_token']
         @code          = nil
-        send :expires_at=
+        send(:expires_at=, response['expires_in'])
         to_hash
       end
 
       private
 
+      def expires_at=(expires_at = nil)
+        additional_second = expires_at || 3600
+        @expires_at = Time.now + additional_second
+      end
+
       def load_file
         file = Apis::CONFIG[:DEFAULT][:CLIENT_SECRET][:PATH]
         MultiJson.load(File.open(file, 'r').read)
@@ -107,15 +113,10 @@ module Base
       end
 
       def fetch_token
-        request_parameters = to_hash.merge(grant_type: grant_type)
-        uri                = URI.parse(TOKEN_URI.to_s)
-        response           = Net::HTTP.post_form(uri, request_parameters)
-
-        JSON.parse response.body
-      end
-
-      def expires_at=(expires_at = nil)
-        @expires_at = expires_at || Time.now + 3600
+        body = to_hash.merge(grant_type: grant_type)
+        uri  = generate_uri('oauth/token')
+        clnt = HTTPClient.new
+        clnt.post(uri, body)
       end
     end
   end

data/lib/base/apis.rb

@@ -1,3 +1,4 @@
+require 'httpclient'
 require 'net/http'
 require 'open-uri'
 require 'pathname'

data/lib/base/apis/category.rb

@@ -6,9 +6,13 @@ module Base
       attr_reader :client_secret
 
       def index
-        uri     = generate_uri('categories?')
-        request = generate_request(uri, client_secret.header_parameter)
-        start(request, uri)
+        clnt = HTTPClient.new
+        uri  = generate_uri('categories?')
+
+        clnt.get(
+          uri,
+          nil,
+          client_secret.header_parameter)
       end
     end
   end

data/lib/base/apis/delivery_company.rb

@@ -6,9 +6,13 @@ module Base
       attr_reader :client_secret
 
       def index
-        uri     = generate_uri('delivery_companies?')
-        request = generate_request(uri, client_secret.header_parameter)
-        start(request, uri)
+        clnt = HTTPClient.new
+        uri  = generate_uri('delivery_companies?')
+
+        clnt.get(
+          uri,
+          nil,
+          client_secret.header_parameter)
       end
     end
   end

data/lib/base/apis/item.rb

@@ -12,16 +12,15 @@ module Base
         #   sort:   'asc or desc',
         #   limit:  1..100,
         #   offset: 0 }
-        request_parameters = block_given? ? yield : {}
 
-        uri =
-          URI(
-            [Apis::API_HOST,
-             "/#{Apis::API_VERSION}/items/?",
-             URI.encode_www_form(request_parameters)].join)
+        clnt = HTTPClient.new
+        uri  = generate_uri('items')
+        body = block_given? ? yield : {}
 
-        request = generate_request(uri, client_secret.header_parameter)
-        start(request, uri)
+        clnt.get(
+          uri,
+          body,
+          client_secret.header_parameter)
       end
     end
   end

data/lib/base/apis/item_category.rb

@@ -6,9 +6,13 @@ module Base
       attr_reader :client_secret
 
       def detail(item_id)
-        uri     = generate_uri("item_categories/detail/#{item_id}")
-        request = generate_request(uri, client_secret.header_parameter)
-        start(request, uri)
+        clnt = HTTPClient.new
+        uri  = generate_uri("item_categories/detail/#{item_id}")
+
+        clnt.get(
+          uri,
+          nil,
+          client_secret.header_parameter)
       end
     end
   end

data/lib/base/apis/order.rb

@@ -12,16 +12,15 @@ module Base
         #   end_ordered:   '2016-01-10',
         #   limit:         20,
         #   offset:        0 }
-        request_parameters = block_given? ? yield : {}
 
-        uri =
-          URI([
-            API_HOST,
-            "/#{API_VERSION}/orders?",
-            URI.encode_www_form(request_parameters)].join)
+        clnt = HTTPClient.new
+        uri  = generate_uri('orders')
+        body = block_given? ? yield : {}
 
-        request = generate_request(uri, client_secret.header_parameter)
-        start(request, uri)
+        clnt.get(
+          uri,
+          body,
+          client_secret.header_parameter)
       end
     end
   end

data/lib/base/apis/saving.rb

@@ -12,16 +12,15 @@ module Base
         #   end_created:   '2016-01-10',
         #   limit:         20,
         #   offset:        0 }
-        request_parameters = block_given? ? yield : {}
 
-        uri =
-          URI([
-            API_HOST,
-            "/#{API_VERSION}/savings?",
-            URI.encode_www_form(request_parameters)].join)
+        clnt = HTTPClient.new
+        uri  = generate_uri('savings')
+        body = block_given? ? yield : {}
 
-        request = generate_request(uri, client_secret.header_parameter)
-        start(request, uri)
+        clnt.get(
+          uri,
+          body,
+          client_secret.header_parameter)
       end
     end
   end

data/lib/base/apis/search.rb

@@ -3,19 +3,20 @@ module Base
     class Search
       include HTTP
       include Apis
-      attr_reader   :client_secret
-      attr_accessor :request_parameters, :uri
+      attr_reader :client_secret
 
       def request(query, &block)
-        send(:request_parameters=, query, &block)
-        send(:uri=, request_parameters)
-        request = generate_request(uri)
-        start(request, uri)
-      end
+        clnt = HTTPClient.new
+        uri  = generate_uri('search')
+        body = generate_body(query, &block)
 
-      private
+        clnt.get(
+          uri,
+          body,
+          client_secret.header_parameter)
+      end
 
-      def request_parameters=(query)
+      def generate_body(query)
         # https://github.com/baseinc/api-docs/blob/master/base_api_v1_search.md
         #
         # { client_id:     'client id for search',
@@ -26,21 +27,13 @@ module Base
         #   size:          10,
         #   fields:        'shop_name, title, detail',
         #   shop_id:       '' }
+
         given_parameters = block_given? ? yield : {}
         default =
           { client_id:     @client_secret.search_client_id,
             client_secret: @client_secret.search_client_secret }
 
-        @request_parameters =
-          default.merge(given_parameters).merge(q: query)
-      end
-
-      def uri=(request_parameters)
-        @uri =
-          URI([
-            API_HOST,
-            "/#{API_VERSION}/search?",
-            URI.encode_www_form(request_parameters)].join)
+        default.merge(given_parameters).merge(q: query)
       end
     end
   end

data/lib/base/apis/user.rb

@@ -6,9 +6,13 @@ module Base
       attr_reader :client_secret
 
       def me
-        uri     = generate_uri('/users/me')
-        request = generate_request(uri, client_secret.header_parameter)
-        start(request, uri)
+        clnt = HTTPClient.new
+        uri  = generate_uri('users/me')
+
+        clnt.get(
+          uri,
+          nil,
+          client_secret.header_parameter)
       end
     end
   end

data/lib/base/http.rb

@@ -1,22 +1,10 @@
 module Base
   module HTTP
     def generate_uri(partial_path)
-      URI.join(
-        Apis::API_HOST.to_s,
-        "/#{Apis::API_VERSION}/#{partial_path}")
-    end
-
-    def generate_request(uri, header_parameter = nil)
-      Net::HTTP::Get.new(uri, header_parameter)
-    end
-
-    def start(request, uri)
-      Net::HTTP.start(
-        uri.hostname,
-        uri.port,
-        use_ssl: uri.scheme == 'https') do |http|
-          http.request(request)
-        end
+      [Apis::API_HOST.to_s,
+       Apis::API_VERSION,
+       partial_path]
+        .join('/')
     end
   end
 end

data/spec/base/api_client/client_secret_spec.rb

@@ -7,12 +7,6 @@ RSpec.describe Base::APIClient::ClientSecret do
 
   before(:each) do
     allow(Time).to receive(:now) { Time.new(2016) }
-    allow_any_instance_of(Base::APIClient::ClientSecret)
-      .to receive(:fetch_token) do
-      { access_token:  'fake_access_token',
-        refresh_token: 'fake_refresh_token',
-        expires_in:     3600 }
-    end
   end
 
   describe '#load_file' do
@@ -86,7 +80,7 @@ RSpec.describe Base::APIClient::ClientSecret do
         it 'set the variable by given value' do
           expect(subject.client_id).to eq 'optional_client_id'
           expect(subject.client_secret).to eq 'optional_client_secret'
-          expect(subject.code).to eq 'optional_code'
+          expect(subject.code).to eq nil
           expect(subject.redirect_uri).to eq 'optional_redirect_uri'
           expect(subject.search_client_id).to eq 'optional_search_client_id'
           expect(subject.search_client_secret).to eq \
@@ -132,7 +126,7 @@ RSpec.describe Base::APIClient::ClientSecret do
         client_id:            'fake_client_id',
         client_secret:        'fake_client_secret',
         code:                  nil,
-        expires_at:            nil,
+        expires_at:            Date.parse(Time.new(2016).to_s).to_time + 3600,
         redirect_uri:         'http://fake_redirect_uri.com',
         access_token:          nil,
         refresh_token:         nil,
@@ -144,7 +138,7 @@ RSpec.describe Base::APIClient::ClientSecret do
   describe '#to_json' do
     it 'returns values of instance variables in json' do
       expect(subject.send(:to_json)).to eq \
-        <<"EOS""{\"client_id\":\"fake_client_id\",\"client_secret\":\"fake_client_secret\",\"code\":null,\"expires_at\":null,\"redirect_uri\":\"http://fake_redirect_uri.com\",\"access_token\":null,\"refresh_token\":null,\"search_client_id\":\"fake_search_client_id\",\"search_client_secret\":\"fake_search_client_secret\"}"
+        <<"EOS""{\"client_id\":\"fake_client_id\",\"client_secret\":\"fake_client_secret\",\"code\":null,\"expires_at\":\"2016-01-01 01:00:00 +0900\",\"redirect_uri\":\"http://fake_redirect_uri.com\",\"access_token\":null,\"refresh_token\":null,\"search_client_id\":\"fake_search_client_id\",\"search_client_secret\":\"fake_search_client_secret\"}"
 EOS
     end
   end
@@ -201,36 +195,54 @@ EOS
 
   describe '#fetch_token' do
     context 'grant_type is "authorization_code"' do
-      it 'returns access and refresh tokens' do
-        stub_request(
-          :post,
-          URI.parse(Base::APIClient::ClientSecret::TOKEN_URI.to_s))
-          .with(body:
-            subject
-            .send(:to_hash)
-            .merge(grant_type: 'authorization_code'))
-
-        expect(subject.send(:fetch_token)).to eq(
-          access_token:  'fake_access_token',
-          refresh_token: 'fake_refresh_token',
-          expires_in:     3600)
+      let(:response) do
+        subject.grant_type = 'authorization_code'
+        VCR.use_cassette('client_secret/fetch_token_authorization_code') do
+          subject.send(:fetch_token)
+        end
+      end
+
+      it 'status is 200' do
+        expect(response.status).to eq 200
+      end
+
+      it 'returns access_token, token_type, expires_in, and refresh_token' do
+        expect(JSON.parse(response.body).keys).to eq \
+          %w(access_token token_type expires_in refresh_token)
+      end
+
+      it 'token_type is bearer' do
+        expect(JSON.parse(response.body)['token_type']).to eq 'bearer'
+      end
+
+      it 'expires_in is 3600' do
+        expect(JSON.parse(response.body)['expires_in']).to eq 3600
       end
     end
 
     context 'grant_type is "refresh_token"' do
-      it 'returns access and refresh tokens' do
-        stub_request(
-          :post,
-          URI.parse(Base::APIClient::ClientSecret::TOKEN_URI.to_s))
-          .with(body:
-            subject
-            .send(:to_hash)
-            .merge(grant_type: 'refresh_token'))
-
-        expect(subject.send(:fetch_token)).to eq(
-          access_token:  'fake_access_token',
-          refresh_token: 'fake_refresh_token',
-          expires_in:     3600)
+      let(:response) do
+        subject.grant_type = 'refresh_token'
+        VCR.use_cassette('client_secret/fetch_token_refresh_token') do
+          subject.send(:fetch_token)
+        end
+      end
+
+      it 'status is 200' do
+        expect(response.status).to eq 200
+      end
+
+      it 'returns access_token, token_type, expires_in, and refresh_token' do
+        expect(JSON.parse(response.body).keys).to eq \
+          %w(access_token token_type expires_in refresh_token)
+      end
+
+      it 'token_type is bearer' do
+        expect(JSON.parse(response.body)['token_type']).to eq 'bearer'
+      end
+
+      it 'expires_in is 3600' do
+        expect(JSON.parse(response.body)['expires_in']).to eq 3600
       end
     end
   end
@@ -241,10 +253,11 @@ EOS
     end
 
     before do
-      allow(subject).to receive(:fetch_token) do
+      allow_any_instance_of(Base::APIClient::ClientSecret)
+        .to receive_message_chain(:fetch_token, :body) do
         { 'access_token'  => 'stubbed_access_token',
           'refresh_token' => 'stubbed_refresh_token',
-          'expires_in'    => 3600 }
+          'expires_in'    => 3600 }.to_json
       end
     end
 
@@ -307,23 +320,30 @@ EOS
     end
 
     describe '#expires_at=' do
-      let(:time) { Date.parse(Time.new(2016).to_s).to_time + 3600 }
+      let(:additional_second) { 3600 }
+      before do
+        allow(Time).to receive(:now) do
+          Date.parse(Time.new(2016).to_s).to_time
+        end
+      end
 
       context 'an arg given' do
         it 'returns expires_at' do
-          subject.send(:expires_at=, time)
-          expect(subject.expires_at).to eq time
+          subject.send(:expires_at=, additional_second)
+          expect(subject.expires_at).to eq expected_expires_at
+        end
+
+        it 'returns expires_at' do
+          seconds = 99_999
+          subject.send(:expires_at=, seconds)
+          expect(subject.expires_at).to eq Time.now + seconds
         end
       end
 
       context 'none is given' do
         it 'returns expires_at' do
-          allow(Time).to receive(:now) do
-            Date.parse(Time.new(2016).to_s).to_time
-          end
-
           subject.send(:expires_at=)
-          expect(subject.expires_at).to eq time
+          expect(subject.expires_at).to eq Time.now + 3600
         end
       end
     end