base-api-client 0.1.beta

data/lib/base/apis.rb

@@ -0,0 +1,20 @@
+require 'net/http'
+require 'open-uri'
+require 'pathname'
+require 'multi_json'
+require 'os'
+
+module Base
+  module Apis
+    ROOT = Pathname(File.expand_path('.'))
+    API_HOST    = Pathname('https://api.thebase.in')
+    API_VERSION = '1'.freeze
+
+    CONFIG =
+      { DEFAULT:
+          { CLIENT_SECRET:
+            { PATH: ROOT / 'config/client_secret.json' } } }.freeze
+
+    Dir.glob(ROOT / 'lib/base/api*/**/*.rb').each { |file| require file }
+  end
+end

data/spec/base/api_client/client_secret_spec.rb

@@ -0,0 +1,321 @@
+require 'spec_helper'
+
+RSpec.describe Base::APIClient::ClientSecret do
+  subject { Base::APIClient::ClientSecret.new }
+  let(:secret_file) { FIXTURES_PATH / 'files' / 'client_secret.json' }
+  let(:data) { MultiJson.load(File.open(secret_file, 'r').read) }
+
+  before(:each) do
+    allow_any_instance_of(Base::APIClient::ClientSecret)
+      .to receive(:fetch_token) do
+      { access_token:  'fake_access_token',
+        refresh_token: 'fake_refresh_token' }
+    end
+  end
+
+  describe '#load_file' do
+    it 'reads client_secret.json' do
+      obj = instance_double('ClientSecret')
+      allow(obj).to receive(:load_file) { data }
+      expect(obj.send(:load_file)).to eq data
+    end
+  end
+
+  describe '::new' do
+    describe 'existence of instance variables' do
+      it 'has @client_id' do
+        expect(subject).to respond_to(:client_id)
+      end
+
+      it 'has @client_secret' do
+        expect(subject).to respond_to(:client_secret)
+      end
+
+      it 'has @code' do
+        expect(subject).to respond_to(:code)
+      end
+
+      it 'has @redirect_uri' do
+        expect(subject).to respond_to(:redirect_uri)
+      end
+
+      it 'has @search_client_id' do
+        expect(subject).to respond_to(:search_client_id)
+      end
+
+      it 'has @search_client_secret' do
+        expect(subject).to respond_to(:search_client_secret)
+      end
+    end
+
+    describe 'without parameters' do
+      it 'instance variables have correct values' do
+        expect(subject.client_id).to eq 'fake_client_id'
+        expect(subject.client_secret).to eq 'fake_client_secret'
+        expect(subject.code).to eq 'fake_code'
+        expect(subject.redirect_uri).to eq 'http://fake_redirect_uri.com'
+        expect(subject.search_client_id).to eq 'fake_search_client_id'
+        expect(subject.search_client_secret).to eq 'fake_search_client_secret'
+      end
+    end
+
+    describe 'with parameters' do
+      subject do
+        Base::APIClient::ClientSecret.new do |zelf|
+          zelf.client_id = 'optional_client_id'
+          zelf.client_secret = 'optional_client_secret'
+          zelf.code = 'optional_code'
+          zelf.redirect_uri = 'optional_redirect_uri'
+          zelf.search_client_id = 'optional_search_client_id'
+          zelf.search_client_secret = 'optional_search_client_secret'
+        end
+      end
+
+      describe 'content of variables' 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.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 \
+            'optional_search_client_secret'
+        end
+      end
+    end
+  end
+
+  describe '#update' do
+    it 'update attributes of the instance' do
+      subject.update! do |zelf|
+        zelf.client_id            = 'updated_client_id'
+        zelf.client_secret        = 'updated_client_secret'
+        zelf.code                 = 'updated_code'
+        zelf.redirect_uri         = 'updated_redirect_uri'
+        zelf.search_client_id     = 'updated_search_client_id'
+        zelf.search_client_secret = 'updated_search_client_secret'
+      end
+
+      expect(subject.client_id).to eq 'updated_client_id'
+      expect(subject.client_secret).to eq 'updated_client_secret'
+      expect(subject.code).to eq 'updated_code'
+      expect(subject.redirect_uri).to eq 'updated_redirect_uri'
+      expect(subject.search_client_id).to eq 'updated_search_client_id'
+      expect(subject.search_client_secret).to eq 'updated_search_client_secret'
+    end
+  end
+
+  describe '#header_parameter' do
+    it 'returns correct parameter' do
+      subject.instance_variable_set(:@access_token, 'fake_access_token')
+      expect(subject.header_parameter).to eq(
+        'Authorization' => 'Bearer fake_access_token')
+    end
+  end
+
+  describe '#to_hash' do
+    it 'returns values of instance variables in hash' do
+      expect(subject.send(:to_hash)).to eq(
+        client_id:            'fake_client_id',
+        client_secret:        'fake_client_secret',
+        code:                 'fake_code',
+        redirect_uri:         'http://fake_redirect_uri.com',
+        refresh_token:        nil,
+        search_client_id:     'fake_search_client_id',
+        search_client_secret: 'fake_search_client_secret')
+    end
+  end
+
+  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\":\"fake_code\",\"redirect_uri\":\"http://fake_redirect_uri.com\",\"refresh_token\":null,\"search_client_id\":\"fake_search_client_id\",\"search_client_secret\":\"fake_search_client_secret\"}"
+EOS
+    end
+  end
+
+  describe '#generate_authorize_parameters' do
+    it 'returns parameters' do
+      expect(subject.send(:generate_authorize_parameters)).to eq \
+        <<"EOS""?client_id=fake_client_id&redirect_uri=http://fake_redirect_uri.com&state=&response_type=code&scope=read_items read_orders read_savings read_users read_users_mail write_items write_orders"
+EOS
+    end
+  end
+
+  describe '#command' do
+    context 'OS is Linux' do
+      it 'returns "sensible-browser"' do
+        allow(OS).to receive(:linux?) { true }
+        expect(subject.send(:command)).to eq 'sensible-browser'
+      end
+    end
+
+    context 'OS is OSX' do
+      it 'returns "open"' do
+        allow(OS).to receive(:linux?) { false }
+        allow(OS).to receive(:mac?) { true }
+        expect(subject.send(:command)).to eq 'open'
+      end
+    end
+  end
+
+  describe '#generate_code' do
+    context 'OS is Linux' do
+      before(:each) do
+        allow(subject).to receive(:command) { 'sensible-browser' }
+      end
+
+      it 'call sensible-browser' do
+        expect(subject).to receive(:system).with(
+          'sensible-browser',
+          'https://api.thebase.in/1/oauth/authorize?client_id=fake_client_id&redirect_uri=http://fake_redirect_uri.com&state=&response_type=code&scope=read_items read_orders read_savings read_users read_users_mail write_items write_orders')
+
+        subject.send(:generate_code)
+      end
+
+      it 'returns ture' do
+        allow(subject).to receive(:generate_code) { true }
+        expect(subject.send(:generate_code)).to eq true
+      end
+    end
+
+    context 'OS is OSX' do
+      before(:each) do
+        allow(subject).to receive(:command) { 'open' }
+      end
+
+      it 'call open' do
+        expect(subject).to receive(:system).with(
+          'open',
+          'https://api.thebase.in/1/oauth/authorize?client_id=fake_client_id&redirect_uri=http://fake_redirect_uri.com&state=&response_type=code&scope=read_items read_orders read_savings read_users read_users_mail write_items write_orders')
+
+        subject.send(:generate_code)
+      end
+
+      it 'returns ture' do
+        allow(subject).to receive(:generate_code) { true }
+        expect(subject.send(:generate_code)).to eq true
+      end
+    end
+  end
+
+  describe '#fetch_token' do
+    context 'passed arg "refresh: false"' do
+      let(:arg) { { refresh: false } }
+
+      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, arg)).to eq(
+          access_token:  'fake_access_token',
+          refresh_token: 'fake_refresh_token')
+      end
+    end
+
+    context 'passed arg "refresh: true"' do
+      let(:arg) { { refresh: true } }
+
+      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, arg)).to eq(
+          access_token:  'fake_access_token',
+          refresh_token: 'fake_refresh_token')
+      end
+    end
+  end
+
+  describe '#set_tokens!' do
+    context 'passed arg "refresh: false"' do
+      let(:arg) { { refresh: false } }
+
+      it 'set access and refresh tokens' do
+        allow(subject).to receive(:fetch_token) do
+          { 'access_token'  => 'stubbed_access_token',
+            'refresh_token' => 'stubbed_refresh_token' }
+        end
+
+        subject.send(:set_tokens!, arg)
+        expect(subject.access_token).to  eq 'stubbed_access_token'
+        expect(subject.refresh_token).to eq 'stubbed_refresh_token'
+      end
+    end
+
+    context 'passed arg "refresh: true"' do
+      let(:arg) { { refresh: true } }
+
+      it 'set access and refresh tokens' do
+        allow(subject).to receive(:fetch_token).with(arg) do
+          { 'access_token'  => 'stubbed_access_token',
+            'refresh_token' => 'stubbed_refresh_token' }
+        end
+
+        subject.send(:set_tokens!, arg)
+        expect(subject.access_token).to  eq 'stubbed_access_token'
+        expect(subject.refresh_token).to eq 'stubbed_refresh_token'
+      end
+    end
+  end
+
+  describe '#my_info' do
+    let(:response) do
+      VCR.use_cassette('ClientSecret_my_info') { subject.my_info }
+    end
+
+    it 'contains code "200"' do
+      expect(response.code).to eq '200'
+    end
+
+    it '@body contains information of the user' do
+      expect(response.body).to match(/user/)
+      expect(response.body).to match(/shop_id/)
+      expect(response.body).to match(/shop_name/)
+      expect(response.body).to match(/shop_introduction/)
+      expect(response.body).to match(/shop_url/)
+      expect(response.body).to match(/twitter_id/)
+      expect(response.body).to match(/facebook_id/)
+      expect(response.body).to match(/ameba_id/)
+      expect(response.body).to match(/instagram_id/)
+      expect(response.body).to match(/background/)
+      expect(response.body).to match(/display_background/)
+      expect(response.body).to match(/repeat_background/)
+      expect(response.body).to match(/logo/)
+      expect(response.body).to match(/display_logo/)
+      expect(response.body).to match(/mail_address/)
+    end
+  end
+
+  describe '#my_items' do
+    let(:response) do
+      VCR.use_cassette('ClientSecret_my_items') { subject.my_items }
+    end
+
+    it 'contains code "200"' do
+      expect(response.code).to eq '200'
+    end
+
+    it '@body contains information of the items' do
+      expect(response.body).to match(/items/)
+      expect(response.body).to match(/item_id/)
+      expect(response.body).to match(/title/)
+      expect(response.body).to match(/detail/)
+      expect(response.body).to match(/price/)
+      expect(response.body).to match(/stock/)
+      expect(response.body).to match(/visible/)
+      expect(response.body).to match(/list_order/)
+      expect(response.body).to match(/identifier/)
+    end
+  end
+end

data/spec/base/apis/category_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+RSpec.describe Base::Apis::Category do
+  let(:client_secret) { Base::APIClient::ClientSecret.new }
+  subject { Base::Apis::Category.new client_secret }
+
+  describe '::new' do
+    include_examples 'Base::Apis::Something.new'
+  end
+
+  describe '#request' do
+    let(:response) { VCR.use_cassette('Category_request') { subject.request } }
+
+    it 'contains code "200"' do
+      expect(response.code).to eq '200'
+    end
+
+    it '@body contains categories' do
+      expect(response.body).to match(/categories/)
+    end
+  end
+end

data/spec/base/apis/delivery_company_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.describe Base::Apis::DeliveryCompany do
+  let(:client_secret) { Base::APIClient::ClientSecret.new }
+  subject { Base::Apis::DeliveryCompany.new client_secret }
+
+  describe '::new' do
+    include_examples 'Base::Apis::Something.new'
+  end
+
+  describe '#request' do
+    let(:response) do
+      VCR.use_cassette('DeliveryCompany_request') { subject.request }
+    end
+
+    it 'contains code "200"' do
+      expect(response.code).to eq '200'
+    end
+
+    it '@body contains information of the delivery companies' do
+      expect(response.body).to match(/delivery_companies/)
+      expect(response.body).to match(/delivery_company_id/)
+      expect(response.body).to match(/name/)
+    end
+  end
+end

data/spec/base/apis/item_category/detail_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe Base::Apis::ItemCategory::Detail do
+  let(:client_secret) { Base::APIClient::ClientSecret.new }
+  subject { Base::Apis::ItemCategory::Detail.new client_secret }
+
+  describe '::new' do
+    include_examples('Base::Apis::Something.new')
+  end
+
+  describe '#request' do
+    let(:response) do
+      VCR.use_cassette('Detail_request') { subject.request(2453256) }
+    end
+
+    it 'contains code "200"' do
+      expect(response.code).to eq '200'
+    end
+
+    it '@body contains categories' do
+      expect(response.body).to match(/item_categories/)
+    end
+  end
+end

data/spec/base/apis/order_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+RSpec.describe Base::Apis::Order do
+  let(:client_secret) { Base::APIClient::ClientSecret.new }
+  subject { Base::Apis::Order.new client_secret }
+
+  describe '::new' do
+    include_examples 'Base::Apis::Something.new'
+  end
+
+  describe '#request' do
+    let(:response) { VCR.use_cassette('Order_request') { subject.request } }
+
+    it 'contains code "200"' do
+      expect(response.code).to eq '200'
+    end
+
+    it '@body contains orders' do
+      expect(response.body).to match(/orders/)
+    end
+  end
+end

data/spec/base/apis/saving_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+RSpec.describe Base::Apis::Saving do
+  let(:client_secret) { Base::APIClient::ClientSecret.new }
+  subject { Base::Apis::Saving.new client_secret }
+
+  describe '::new' do
+    include_examples 'Base::Apis::Something.new'
+  end
+
+  describe '#request' do
+    let(:response) { VCR.use_cassette('Saving_request') { subject.request } }
+
+    it 'contains code "200"' do
+      expect(response.code).to eq '200'
+    end
+
+    it '@body contains saving' do
+      expect(response.body).to match(/saving/)
+    end
+  end
+end

data/spec/base/apis/search_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+RSpec.describe Base::Apis::Search do
+  let(:client_secret) { Base::APIClient::ClientSecret.new }
+  subject { Base::Apis::Search.new client_secret }
+  let(:query) { '白 シャツ 綿' }
+  let(:request_parameters) do
+    {  client_id:     '623f75000821c16163ec570ca6469539',
+       client_secret: 'e321f43620ac47bc92f83e766107d78c',
+       q:             query }
+  end
+
+  describe '::new' do
+    include_examples 'Base::Apis::Something.new'
+  end
+
+  describe '#request' do
+    let(:response) do
+      VCR.use_cassette('Search_request') { subject.request(query) }
+    end
+
+  it 'contains code "200"' do
+    expect(response.code).to eq '200'
+  end
+
+    it '@body contains searched items info' do
+      expect(response.body).to match(/found/)
+      expect(response.body).to match(/items/)
+      expect(response.body).to match(/item_id/)
+      expect(response.body).to match(/title/)
+      expect(response.body).to match(/detail/)
+      expect(response.body).to match(/price/)
+      expect(response.body).to match(/stock/)
+      expect(response.body).to match(/modified/)
+      expect(response.body).to match(/shop_id/)
+      expect(response.body).to match(/shop_name/)
+      expect(response.body).to match(/shop_url/)
+      expect(response.body).to match(/categories/)
+    end
+  end
+
+  describe '#request_parameters=' do
+    it 'returns request_parameters' do
+      client_secret = instance_double('Base::Apis::ClientSecret')
+
+      client_secret.instance_variable_set(
+        :@search_client_id,
+        '623f75000821c16163ec570ca6469539')
+
+      client_secret.instance_variable_set(
+        :@search_client_secret,
+        'e321f43620ac47bc92f83e766107d78c')
+
+      allow(subject).to receive(:client_secret) { client_secret }
+
+      expect(subject).to respond_to(:request_parameters) do
+        {  client_id:     '623f75000821c16163ec570ca6469539',
+           client_secret: 'e321f43620ac47bc92f83e766107d78c',
+           q:             '白 シャツ 綿' }
+      end
+
+      subject.send(:request_parameters=, '白 シャツ 綿')
+    end
+  end
+
+  describe '#uri=' do
+    it 'has instance variable @uri' do
+      expect(subject).to respond_to(:uri)
+    end
+
+    it 'returns an object of URI::HTTPS' do
+      expect(subject.send(:uri=, request_parameters)).to \
+        be_kind_of URI::HTTPS
+    end
+
+    it 'return value to_s is uri like' do
+      expect(subject.send(:uri=, request_parameters).to_s).to eq \
+        'https://api.thebase.in/1/search?client_id=623f75000821c16163ec570ca6469539&client_secret=e321f43620ac47bc92f83e766107d78c&q=%E7%99%BD+%E3%82%B7%E3%83%A3%E3%83%84+%E7%B6%BF'
+    end
+  end
+end

data/spec/fixtures/files/client_secret.json

@@ -0,0 +1,10 @@
+{
+  "client_id":     "fake_client_id",
+  "client_secret": "fake_client_secret",
+  "code":          "fake_code",
+  "redirect_uri":  "http://fake_redirect_uri.com",
+  "search": {
+    "client_id":     "fake_search_client_id",
+    "client_secret": "fake_search_client_secret"
+  }
+}

data/spec/fixtures/vcr_cassettes/Category_request.yml

@@ -0,0 +1,81 @@
+---
+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":"cb502f8cd62733e805182af85dc86f5d","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 cb502f8cd62733e805182af85dc86f5d
+      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

data/spec/fixtures/vcr_cassettes/ClientSecret_my_info.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.thebase.in/1/users/me
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - Bearer d1347e05cf1441ec9770c2362580a5a5
+      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:
+      - Sun, 07 Feb 2016 13:39:44 GMT
+      Server:
+      - Apache
+      Vary:
+      - Accept-Encoding,User-Agent
+      Content-Length:
+      - '226'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: '{"user":{"shop_id":"ysksn-base-ec","shop_name":"ysksn","shop_introduction":"\u304f\u3058\u3089\u306e\u305b\u3064\u3081\u3044","shop_url":"http:\/\/ysksn.base.ec","twitter_id":"","facebook_id":"","ameba_id":"","instagram_id":"","background":null,"display_background":0,"repeat_background":1,"logo":null,"display_logo":0,"mail_address":"bluewhale1982@gmail.com"}}'
+    http_version: 
+  recorded_at: Sun, 07 Feb 2016 13:39:44 GMT
+recorded_with: VCR 3.0.1