base-api-client 0.2.4.beta → 0.2.5.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2049e5a041b193725cedb8ba838866bb0f5b893c
-  data.tar.gz: 4bc4c3c911f59ca70117c8c6c0a784b5996e7b6e
+  metadata.gz: a1fed7d3ac2e80f26b6e9ff9079d0248ad2e040e
+  data.tar.gz: 7de0a5801e6658017d3bc0868ab91af3f623722c
 SHA512:
-  metadata.gz: d26d8081069b011a9429e7bce75c842f0fe5670cbe1f0a15204c45263eef680795e554b1f80f6971103c192a74e9e0a8fee8e22f5a54dc4f76363ace617d4564
-  data.tar.gz: fdf932804c2514f6d4e112902dd4e7c0cc62d44d8711b358f6858c489edc4e56e4bcd6fbb83f52ecf0a904e2a0a4eaf3eddf56d34918a2d7d728464c2d846acd
+  metadata.gz: c7e2b15ab31c4f215de99c64fcef91c17287837f736efac0cf8cce9aacb30035012d335a89784240f5db2553b89e7472a15de6a0e1f9f675ea4eb05d6970ad14
+  data.tar.gz: d7313ee4c07b28c377d29419fdcf4980d815febc4f15bf97fd2f5063d1bf40c25c2f5239dbc3016fb804f3a2d82fb6cab899373c77c71fa8ed1c328c324a2a57

data/README.md

@@ -0,0 +1,131 @@
+# base-api-ruby-client
+This library is in Beta, so don't expect too much.
+
+## Demo
+[Demo](https://github.com/ysksn/base-api-ruby-client-samples)
+
+## Requirements
+- Ruby 2.2.2 or higher
+- [BASE developer account](https://developers.thebase.in/apply)
+
+## Installation
+Add this line to your application's Gemfile:
+```
+gem 'base-api-client'
+```
+And then execute:
+```
+$ bundle
+```
+
+## Usage
+Don't forget to require those modules and classes.
+```ruby
+require 'base/apis'
+require 'base/api_client/client_secret'
+```
+
+### Create an instance of ClientSecret
+```ruby
+# Read default from config/client_secret.json
+client_secret = Base::APIClient::ClientSecret.new
+```
+or
+```ruby
+client_secret =
+  Base::APIClient::ClientSecret.new(
+    client_id:            'e0b20d3fbb62bb5db4ebbb4ebebd43fb',
+    client_secret:        'bd4b3ebbdbbebb6b6fb1d1bbb100b66b',
+    redirect_uri:         'http://localhost.local/oauth2callback',
+    search_client_id:     '623fb5000b21b16163eb5b0bb646b53b',
+    search_client_secret: '214b4134022dfbbf0230f5b0bbbbb2db')
+```
+
+### Generate URI to retrieve code
+```ruby
+client_secret.generate_code_uri
+```
+
+Set code
+```ruby
+client_secret.code = request['code']
+```
+
+### Set access token
+```ruby
+client_secret.set_tokens!
+```
+
+### Retrieve my shop information
+```ruby
+client_secret.my_info
+```
+
+### Retrieve my items
+```ruby
+client_secret.my_items
+```
+
+### Retrieve my orders
+```ruby
+orders = Base::Apis::Order.new(client_secret)
+orders.request
+```
+
+### Retrieve savings
+```ruby
+savings = Base::Apis::Saving.new(client_secret)
+savings.request
+```
+
+### Retrieve delivery companies
+```ruby
+dalivery_companies = Base::Apis::DeliveryCompany.new(client_secret)
+dalivery_companies.request
+```
+
+### Retrieve item categories
+```ruby
+categories = Base::Apis::Category.new(client_secret)
+categories.request
+```
+
+### Retrieve detailed item category
+```ruby
+category = Base::Apis::ItemCategory::Detail.new(client_secret)
+category.request(2_453_256)
+```
+
+### Search items
+```ruby
+search = Base::Apis::Search.new(client_secret)
+search.request('Tシャツ 白 シルクスクリーン 綿')
+```
+See [samples](https://github.com/ysksn/base-api-ruby-client-samples/blob/tmp/sample.rb)
+
+### TODO(s)
+- Implement more such as:
+  - Add
+    - Item
+    - Item image
+    - Category
+    - Item Category
+  - Delete
+    - Item info
+    - Item image
+    - Item variation
+    - Category
+  - Update
+    - Item info
+    - Item stok
+    - Order status
+  - Search
+    - Refresh result
+
+## License
+This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/ysksn/base-api-ruby-client/blob/master/LICENSE)
+
+## References
+- [BASE](https://thebase.in/)
+- [BASE API v1 Document](https://github.com/baseinc/api-docs)
+- [ysksn/base-api-ruby-client](https://github.com/ysksn/base-api-ruby-client)

data/base-api-client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name                  = 'base-api-client'
-  spec.version               = '0.2.4.beta'
+  spec.version               = '0.2.5.beta'
   spec.author                = 'ysksn'
   spec.email                 = ['bluewhale1982@gmail.com']
   spec.summary               = 'Client for accessing BASE APIs'

data/lib/base/apis/category.rb

@@ -1,6 +1,7 @@
 module Base
   module Apis
     class Category
+      include HTTP
       attr_reader :client_secret
 
       def initialize(client_secret)
@@ -8,13 +9,9 @@ module Base
       end
 
       def request
-        uri     = URI.join(API_HOST.to_s, "/#{API_VERSION}/categories?")
-        request = Net::HTTP::Get.new(uri, client_secret.header_parameter)
-
-        Net::HTTP.start(
-          uri.hostname,
-          uri.port,
-          use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+        uri     = generate_uri('categories?')
+        request = generate_request(uri, client_secret.header_parameter)
+        start(request, uri)
       end
     end
   end

data/lib/base/apis/delivery_company.rb

@@ -1,6 +1,7 @@
 module Base
   module Apis
     class DeliveryCompany
+      include HTTP
       attr_reader :client_secret
 
       def initialize(client_secret)
@@ -8,13 +9,9 @@ module Base
       end
 
       def request
-        uri     = URI.join(API_HOST.to_s, "/#{API_VERSION}/delivery_companies?")
-        request = Net::HTTP::Get.new(uri, client_secret.header_parameter)
-
-        Net::HTTP.start(
-          uri.hostname,
-          uri.port,
-          use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+        uri     = generate_uri('delivery_companies?')
+        request = generate_request(uri, client_secret.header_parameter)
+        start(request, uri)
       end
     end
   end

data/lib/base/apis/item_category/detail.rb

@@ -2,6 +2,7 @@ module Base
   module Apis
     module ItemCategory
       class Detail
+        include HTTP
         attr_reader :client_secret
 
         def initialize(client_secret)
@@ -9,17 +10,9 @@ module Base
         end
 
         def request(item_id)
-          uri =
-            URI.join(
-              API_HOST.to_s,
-              "/#{API_VERSION}/item_categories/detail/#{item_id}")
-
-          request = Net::HTTP::Get.new(uri, client_secret.header_parameter)
-
-          Net::HTTP.start(
-            uri.hostname,
-            uri.port,
-            use_ssl: uri.scheme == 'https') { |http| http.request(request) }
+          uri     = generate_uri("item_categories/detail/#{item_id}")
+          request = generate_request(uri, client_secret.header_parameter)
+          start(request, uri)
         end
       end
     end

data/lib/base/apis/order.rb

@@ -1,6 +1,7 @@
 module Base
   module Apis
     class Order
+      include HTTP
       attr_reader :client_secret
 
       def initialize(client_secret)
@@ -22,14 +23,8 @@ module Base
             "/#{API_VERSION}/orders?",
             URI.encode_www_form(request_parameters)].join)
 
-        request = Net::HTTP::Get.new(uri, client_secret.header_parameter)
-
-        Net::HTTP.start(
-          uri.hostname,
-          uri.port,
-          use_ssl: uri.scheme == 'https') do |http|
-            http.request(request)
-          end
+        request = generate_request(uri, client_secret.header_parameter)
+        start(request, uri)
       end
     end
   end

data/lib/base/apis/saving.rb

@@ -1,6 +1,7 @@
 module Base
   module Apis
     class Saving
+      include HTTP
       attr_reader :client_secret
 
       def initialize(client_secret)
@@ -22,14 +23,8 @@ module Base
             "/#{API_VERSION}/savings?",
             URI.encode_www_form(request_parameters)].join)
 
-        request = Net::HTTP::Get.new(uri, client_secret.header_parameter)
-
-        Net::HTTP.start(
-          uri.hostname,
-          uri.port,
-          use_ssl: uri.scheme == 'https') do |http|
-            http.request(request)
-          end
+        request = generate_request(uri, client_secret.header_parameter)
+        start(request, uri)
       end
     end
   end

data/lib/base/apis/search.rb

@@ -1,6 +1,7 @@
 module Base
   module Apis
     class Search
+      include HTTP
       attr_reader   :client_secret
       attr_accessor :request_parameters, :uri
 
@@ -11,14 +12,8 @@ module Base
       def request(query, &block)
         send(:request_parameters=, query, &block)
         send(:uri=, request_parameters)
-        request = Net::HTTP::Get.new(uri)
-
-        Net::HTTP.start(
-          uri.hostname,
-          uri.port,
-          use_ssl: uri.scheme == 'https') do |http|
-            http.request(request)
-          end
+        request = generate_request(uri)
+        start(request, uri)
       end
 
       private

data/lib/base/apis.rb

@@ -2,6 +2,7 @@ require 'net/http'
 require 'open-uri'
 require 'pathname'
 require 'multi_json'
+require_relative 'http'
 
 module Base
   module Apis
@@ -14,6 +15,6 @@ module Base
           { CLIENT_SECRET:
             { PATH: ROOT / 'config/client_secret.json' } } }.freeze
 
-    Dir.glob(ROOT / 'lib/base/api*/**/*.rb').each { |file| require file }
+    Dir.glob(ROOT / 'lib/base/**/*.rb').each { |file| require file }
   end
 end

data/lib/base/http.rb

@@ -0,0 +1,22 @@
+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
+    end
+  end
+end

data/spec/base/http_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+RSpec.describe Base::HTTP do
+  include Base::HTTP
+  let(:uri) { URI.parse('https://api.thebase.in/1/categories?') }
+  let(:header_parameter) { { 'Authorization' => 'Bearer 888access_token888' } }
+
+  describe '#generate_uri' do
+    it 'returns instance of URI' do
+      expect(generate_uri('partial_path')).to be_kind_of URI
+    end
+
+    it 'returns uri' do
+      %w(apple google/twitter facebook?).each do |partial_path|
+        expect(generate_uri(partial_path)).to eq \
+          URI.parse("https://api.thebase.in/1/#{partial_path}")
+      end
+    end
+  end
+
+  describe '#generate_request' do
+    context 'no header_parameter is given' do
+      it 'returns instance of Net::HTTP::Get' do
+        expect(generate_request(uri)).to be_kind_of Net::HTTP::Get
+      end
+
+      it 'has header_parameter authorization' do
+        expect(
+          generate_request(uri)
+            .instance_variable_get(:@header)['authorization']).to be_nil
+      end
+    end
+
+    context 'header_parameter is given' do
+      it 'returns instance of Net::HTTP::Get' do
+        expect(generate_request(uri, header_parameter))
+          .to be_kind_of Net::HTTP::Get
+      end
+
+      it 'has header_parameter authorization' do
+        expect(
+          generate_request(uri, header_parameter)
+            .instance_variable_get(:@header)['authorization'])
+          .to eq ['Bearer 888access_token888']
+      end
+    end
+  end
+
+  describe '#start' do
+    let(:request) { generate_request(uri, header_parameter) }
+    let(:response) { VCR.use_cassette('HTTP_start') { start(request, uri) } }
+
+    it 'response @code is "200"' do
+      expect(response.code).to eq '200'
+    end
+
+    it 'response @body contains categories' do
+      expect(response.body).to match(/categories/)
+    end
+  end
+end

data/spec/fixtures/vcr_cassettes/HTTP_start.yml

@@ -0,0 +1,82 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.thebase.in/1/oauth/token
+    body:
+      encoding: US-ASCII
+      string: client_id=e0920d3fba627a5da4eaab4e8e9d43fc&client_secret=a7eae9a2903235465e9b43c1116e2046&code=614e48613d8f347eb00444a40fd9e47c&redirect_uri=http%3A%2F%2Flocalhost.local&refresh_token&search_client_id=623f75000821c16163ec570ca6469539&search_client_secret=a52ad8525921ca9a40fee47a38ca429d&grant_type=authorization_code
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - api.thebase.in
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Date:
+      - Mon, 08 Feb 2016 13:51:52 GMT
+      Server:
+      - Apache
+      Vary:
+      - Accept-Encoding,User-Agent
+      Content-Length:
+      - '132'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: '{"access_token":"888access_token888","token_type":"bearer","expires_in":3600,"refresh_token":"8aa0c1d633af7f25909c689e49aab0a1"}'
+    http_version: 
+  recorded_at: Mon, 08 Feb 2016 13:51:53 GMT
+- request:
+    method: get
+    uri: https://api.thebase.in/1/categories
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - Bearer 888access_token888
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - api.thebase.in
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Date:
+      - Mon, 08 Feb 2016 13:51:53 GMT
+      Server:
+      - Apache
+      Vary:
+      - Accept-Encoding,User-Agent
+      Content-Length:
+      - '37'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: '{"categories":[]}'
+    http_version: 
+  recorded_at: Mon, 08 Feb 2016 13:51:53 GMT
+recorded_with: VCR 3.0.1
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base-api-client
 version: !ruby/object:Gem::Version
-  version: 0.2.4.beta
+  version: 0.2.5.beta
 platform: ruby
 authors:
 - ysksn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -23,6 +23,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE
+- README.md
 - base-api-client.gemspec
 - config/client_secret.json
 - lib/base/api_client/client_secret.rb
@@ -30,24 +31,27 @@ files:
 - lib/base/apis/category.rb
 - lib/base/apis/delivery_company.rb
 - lib/base/apis/item_category/detail.rb
-- lib/base/apis/normalization.rb
 - lib/base/apis/order.rb
 - lib/base/apis/saving.rb
 - lib/base/apis/search.rb
+- lib/base/http.rb
+- lib/base/normalization.rb
 - spec/base/api_client/client_secret_spec.rb
 - spec/base/apis/category_spec.rb
 - spec/base/apis/delivery_company_spec.rb
 - spec/base/apis/item_category/detail_spec.rb
-- spec/base/apis/normalization_spec.rb
 - spec/base/apis/order_spec.rb
 - spec/base/apis/saving_spec.rb
 - spec/base/apis/search_spec.rb
+- spec/base/http_spec.rb
+- spec/base/normalization_spec.rb
 - spec/fixtures/files/client_secret.json
 - spec/fixtures/vcr_cassettes/Category_request.yml
 - spec/fixtures/vcr_cassettes/ClientSecret_my_info.yml
 - spec/fixtures/vcr_cassettes/ClientSecret_my_items.yml
 - spec/fixtures/vcr_cassettes/DeliveryCompany_request.yml
 - spec/fixtures/vcr_cassettes/Detail_request.yml
+- spec/fixtures/vcr_cassettes/HTTP_start.yml
 - spec/fixtures/vcr_cassettes/Order_request.yml
 - spec/fixtures/vcr_cassettes/Saving_request.yml
 - spec/fixtures/vcr_cassettes/Search_request.yml
@@ -82,16 +86,18 @@ test_files:
 - spec/base/apis/category_spec.rb
 - spec/base/apis/delivery_company_spec.rb
 - spec/base/apis/item_category/detail_spec.rb
-- spec/base/apis/normalization_spec.rb
 - spec/base/apis/order_spec.rb
 - spec/base/apis/saving_spec.rb
 - spec/base/apis/search_spec.rb
+- spec/base/http_spec.rb
+- spec/base/normalization_spec.rb
 - spec/fixtures/files/client_secret.json
 - spec/fixtures/vcr_cassettes/Category_request.yml
 - spec/fixtures/vcr_cassettes/ClientSecret_my_info.yml
 - spec/fixtures/vcr_cassettes/ClientSecret_my_items.yml
 - spec/fixtures/vcr_cassettes/DeliveryCompany_request.yml
 - spec/fixtures/vcr_cassettes/Detail_request.yml
+- spec/fixtures/vcr_cassettes/HTTP_start.yml
 - spec/fixtures/vcr_cassettes/Order_request.yml
 - spec/fixtures/vcr_cassettes/Saving_request.yml
 - spec/fixtures/vcr_cassettes/Search_request.yml