freee 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1c589c590102035d3d89a4a526279973333251c
-  data.tar.gz: d47aa633efefa7fd6432efdcde48c6d6f11b4a8f
+  metadata.gz: 7775dac3cdd570593801f5cb42c8feb777309c8d
+  data.tar.gz: acbcaf03d3bab36d0a9cbdf23c2be8f84977737a
 SHA512:
-  metadata.gz: 3f43e6a967186c45ad4bcd7015a430628551e211c44d67600a6c597ab81be8695fa5e1a03d1a554dffb109003f8cd5d9c76bbb6ccebe39f9e2740de29544bb6e
-  data.tar.gz: 0ae697091e7b4ce21c0198285a1da78665f70ad5e3596809bc1e9d12fdd6fd3dbaa5ebcf78bc50daa2a84f337db788c8740c16800a0f9564b4e68c08ab430f80
+  metadata.gz: 600303de998cee8f7ece820c5c8b51c685a7d15ccdd21a22d83183dec6cbca0ba7eca590eff98f6ef45f6b6aaf0ea26e5a68954c3744c2b7a1aaba32c0a30877
+  data.tar.gz: 58d9b02faf0d017bf12d21335d7be0612407888d65727b1dd4b6648bb7c2867d009e1c2ff8219359ce806ef389d58397226a2c348130ed502f3b70b7d7ff3dc4

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.a
 mkmf.log
 vendor/*
+.DS_Store

data/README.md

@@ -2,6 +2,10 @@
 
 Ruby implementation of the freee API.
 
+# Document
+
+- [freee API v1.0](https://gist.github.com/yokoji/822edacff497b21fa7bf)(Japanese)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -31,8 +35,28 @@ Or install it yourself as:
 
 ### Generate token
 
+- Generate application token
+
+```
+> freee token \
+  --client-id=$FREEE_CLIENT_ID \
+  --secret-key=$FREEE_SECRET_KEY \
+  --redirect-uri=$FREEE_REDIRECT_URI \
+  --authorization-code=$FREEE_AUTHORIZATION_CODE
+Token: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+RefreshToken: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
+```
+
+- Refresh application token
+
 ```
-> freee token
+> freee token \
+  --client-id=$FREEE_CLIENT_ID \
+  --secret-key=$FREEE_SECRET_KEY \
+  --redirect-uri=$FREEE_REDIRECT_URI \
+  --refresh-token=$FREEE_REFRESH_TOKEN
+Token: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+RefreshToken: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
 ```
 
 ## Contributing

data/freee.gemspec

@@ -27,5 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock'
 end

data/lib/freee/{account.rb → account_item.rb}

@@ -1,9 +1,9 @@
 module Freee
-  class Account < Freee::Base
-    def self.items(company_id)
+  class AccountItem < Freee::Base
+    def self.list(company_id)
       Freee.client.get(
         "/api/1/account_items?company_id=#{company_id.to_i}",
-        :account
+        :account_item
       )
     end
   end

data/lib/freee/base.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'json'
 
 module Freee
   def client
@@ -15,6 +16,13 @@ module Freee
   end
   module_function :encode_params
 
+  def encode_json(params)
+    JSON.parse(params).to_json
+  rescue
+    '?' + URI.encode_www_form(JSON.parse(params, quirks_mode: true))
+  end
+  module_function :encode_json
+
   def includes(file_path, search_path)
     Dir.glob(File.realpath(File.dirname(file_path)) + '/' + search_path).map do |f|
       require f if FileTest.file?(f)
@@ -62,8 +70,11 @@ module Freee
       return Freee::Response::Type.convert(response, type)
     end
 
-    def post(path, type=nil, **kwargs)
-      response = @client.post(path, { params: kwargs }).response.env[:body]
+    def post(path, type=nil, params)
+      response = @client.post(path, { body: {params: params} }).response.env[:body]
+    rescue
+      response = @client.post(path + params).response.env[:body]
+    ensure
       return Freee::Response::Type.convert(response, type)
     end
 

data/lib/freee/company.rb

@@ -7,5 +7,9 @@ module Freee
     def self.list_of_details(company_id)
       Freee.client.get("/api/1/companies/#{company_id.to_i}", :company)
     end
+
+    class << self
+      alias :show :list_of_details
+    end
   end
 end

data/lib/freee/deal.rb

@@ -1,7 +1,9 @@
 module Freee
   class Deal < Freee::Base
-    def create
-      Freeee.client.post('/api/1/deals', :deals, **kwargs)
+
+    def self.create(json)
+      params = Freee.encode_json(json)
+      Freee.client.post('/api//1/deals', :deal, params)
     end
 
     def self.list(company_id, **kwargs)

data/lib/freee/item.rb

@@ -1,7 +1,9 @@
 module Freee
   class Item < Freee::Base
-    def create
-      Freee.client.post('/api/1/items', :item, **kwargs)
+
+    def self.create(json)
+      params = Freee.encode_json(json)
+      Freee.client.post('/api/1/items', :item, params)
     end
 
     def self.list(company_id)

data/lib/freee/obj/account_item.rb

@@ -0,0 +1,5 @@
+module Freee::Response
+  class AccountItem < Base
+  end
+end
+

data/lib/freee/obj/response.rb

@@ -30,7 +30,7 @@ module Freee::Response
 
   class Type
     def self.convert(response, type=nil)
-      klass = "Freee::Response::#{type.to_s.capitalize}".constantize
+      klass = "Freee::Response::#{type.to_s.classify}".constantize
       klass.new(response)
     end
   end

data/lib/freee/obj/{account.rb → section.rb}

@@ -1,5 +1,5 @@
 module Freee::Response
-  class Account < Base
+  class Section < Base
   end
 end
 

data/lib/freee/obj/{wallet.rb → tag.rb}

@@ -1,5 +1,5 @@
 module Freee::Response
-  class Wallet < Base
+  class Tag < Base
   end
 end
 

data/lib/freee/obj/{amount.rb → wallet_txn.rb}

@@ -1,5 +1,5 @@
 module Freee::Response
-  class Amount < Base
+  class WalletTxn < Base
   end
 end
 

data/lib/freee/partner.rb

@@ -1,7 +1,9 @@
 module Freee
   class Partner < Freee::Base
-    def self.create
-      Freee.client.post('/api/1/partners', :partner, **kwargs)
+
+    def self.create(json)
+      params = Freee.encode_json(json)
+      Freee.client.post('/api/1/partners', :partner, params)
     end
 
     def self.list(company_id)

data/lib/freee/section.rb

@@ -0,0 +1,15 @@
+module Freee
+  class Section < Freee::Base
+    def self.create(json)
+      params = Freee.encode_json(json)
+      Freee.client.post('/api/1/sections', :section, params)
+    end
+
+    def self.list(company_id)
+      Freee.client.get(
+        "/api/1/sections?company_id=#{company_id.to_i}",
+        :section
+      )
+    end
+  end
+end

data/lib/freee/tag.rb

@@ -0,0 +1,15 @@
+module Freee
+  class Tag < Freee::Base
+    def self.create(json)
+      params = Freee.encode_json(json)
+      Freee.client.post('/api/1/tags', :tag, params)
+    end
+
+    def self.list(company_id)
+      Freee.client.get(
+        "/api/1/tags?company_id=#{company_id.to_i}",
+        :tag
+      )
+    end
+  end
+end

data/lib/freee/tax.rb

@@ -3,12 +3,12 @@ module Freee
     def self.list(company_id)
       Freee.client.get(
         "/api/1/taxes?company_id=#{company_id.to_i}",
-        :tax
+        :taxes
       )
     end
 
     def self.list_of_code
-      Freee.client.get('/api/1/taxes/codes', :tax)
+      Freee.client.get('/api/1/taxes/codes', :taxes)
     end
   end
 end

data/lib/freee/transfer.rb

@@ -1,7 +1,9 @@
 module Freee
   class Transfer < Freee::Base
-    def self.create
-      Freee.client.post('/api/1/transfers', :transfer, **kwargs)
+
+    def self.create(json)
+      params = Freee.encode_json(json)
+      Freee.client.post('/api//1/transfers', :transfer, params)
     end
 
     def self.list(company_id, **kwargs)

data/lib/freee/version.rb

@@ -1,3 +1,3 @@
 module Freee
-  VERSION = "0.3.1"
+  VERSION = "1.0.0"
 end

data/lib/freee/{wallet.rb → wallet_txn.rb}

@@ -1,14 +1,15 @@
 module Freee
-  class Wallet < Freee::Base
-    def self.create(**kwargs)
-      Freee.client.post('/api/1/wallet_txns', :wallet, **kwargs)
+  class WalletTxn < Freee::Base
+    def self.create(json)
+      params = Freee.encode_json(json)
+      Freee.client.post('/api/1/wallet_txns', :wallet_txn, json)
     end
 
     def self.list(company_id, **kwargs)
       params = Freee.encode_params(kwargs)
       Freee.client.get(
         "/api/1/wallet_txns?company_id=#{company_id.to_i}#{params}",
-        :wallet
+        :wallet_txn
       )
     end
   end

data/lib/freee/walletable.rb

@@ -1,5 +1,11 @@
 module Freee
   class Walletable < Freee::Base
+    def self.create(json)
+      params = Freee.encode_json(json)
+      Freee.client.post('/api/1/walletables', :walletable, params)
+    end
+
+
     def self.list(company_id)
       Freee.client.get(
         "/api/1/walletables?company_id=#{company_id.to_i}",

data/spec/account_item_spec.rb

@@ -0,0 +1,44 @@
+require_relative 'spec_helper'
+
+describe Freee::AccountItem do
+
+  let(:company_id) { -1 }
+
+  before do
+    Freee::Base.config(get_client_id, get_secret_key, get_token)
+    @client = Freee::AccountItem
+  end
+
+  describe '#list' do
+    before do
+      stub_get('/api/1/account_items?company_id=-1').to_return(body: fixture('account_items.json'), headers: {content_type: 'application/json; charset=utf-8'} )
+      @responses = @client.list(company_id)
+    end
+    after { WebMock.reset! }
+
+    it 'requests the correct resource' do
+      assert_request_requested a_get('/api/1/account_items?company_id=-1')
+    end
+
+    it 'should can be able to create instance' do
+      expect(@responses).to include('account_items')
+    end
+
+    describe 'should be get information of account' do
+      subject { @responses }
+      it { is_expected.to include('account_items') }
+      it { is_expected.to be_instance_of(Freee::Response::AccountItem) }
+    end
+
+    describe 'should be get information of account_items' do
+      subject { @responses['account_items'].first }
+
+      it { is_expected.not_to be_nil }
+      it { is_expected.to include('id') }
+      it { is_expected.to include('name') }
+      it { is_expected.to include('shortcut') }
+      it { is_expected.to include('default_tax_id') }
+      it { is_expected.to include('categories') }
+    end
+  end
+end

data/spec/base_spec.rb

@@ -1,20 +1,14 @@
 require 'spec_helper'
 
 describe Freee::Base do
-  let(:client_id) { get_client_id }
-  let(:secret_key) { get_secret_key }
-  let(:token) { get_token }
+
   let(:freee) { Freee::Base.new }
 
-  before(:each) do
-    Freee::Base.config(client_id, secret_key, token)
+  before :each do
+    Freee::Base.config(get_client_id, get_secret_key, get_token)
   end
 
   it 'should be able to get client' do
     expect(freee.client).not_to be_nil
   end
-
-  it 'should be call of get by Freee' do
-    expect(freee.client.get('/api/1/users/me?companies=true')).to include("user")
-  end
 end

data/spec/company_spec.rb

@@ -1,45 +1,62 @@
 require 'spec_helper'
 
 describe Freee::Company do
-  let(:client_id) { get_client_id }
-  let(:secret_key) { get_secret_key }
-  let(:token) { get_token }
-  let(:company_id) { get_company_id }
-  let(:company) { Freee::Company }
-
-  before(:each) do
-    Freee::Base.config(client_id, secret_key, token)
-  end
-
-  describe 'should can be able to create instance' do
-    subject { company.list }
-    it { is_expected.not_to be_nil }
-    it { is_expected.to be_instance_of(Freee::Response::Company) }
-  end
 
-  describe 'should be get first list of company' do
-    subject { company.list["companies"].first }
+  let(:company_id) { -1 }
 
-    it { is_expected.to include('id') }
-    it { is_expected.to include('name') }
-    it { is_expected.to include('name_kana') }
-    it { is_expected.to include('display_name') }
+  before do
+    Freee::Base.config(get_client_id, get_secret_key, get_token)
+    @client = Freee::Company
   end
-  
-  describe 'should be get item of the company' do
-    subject { company.list_of_details(company_id) }
-
-    it { is_expected.to include('company') }
-  end
-
-  describe 'should be get information of item for the company'  do
-    subject { company.list_of_details(company_id)['company'] }
 
-    it { is_expected.not_to be_nil }
-    it { is_expected.to include('id') }
-    it { is_expected.to include('name') }
-    it { is_expected.to include('name_kana') }
-    it { is_expected.to include('display_name') }
-    it { is_expected.to include('role') }
+  describe 'company' do
+    context '#list' do
+      before do
+        stub_get('/api/1/companies').to_return(body: fixture('companies.json'), headers: {content_type: 'application/json; charset=utf-8'} )
+        @responses = @client.list
+      end
+      after { WebMock.reset! }
+
+      it 'requests the correct resource' do
+        assert_request_requested a_get('/api/1/companies')
+      end
+
+      it 'should can be able to create instance' do
+        expect(@responses).to include('companies')
+      end
+
+      describe 'should can be able to create instance' do
+        subject { @responses }
+        it { is_expected.not_to be_nil }
+        it { is_expected.to be_instance_of(Freee::Response::Company) }
+      end
+    end
+
+    context '#show' do
+      before do
+        stub_get('/api/1/companies/-1').to_return(body: fixture('company.json'), headers: {content_type: 'application/json; charset=utf-8'} )
+        @responses = @client.show(company_id)
+      end
+      after { WebMock.reset! }
+
+      it 'requests the correct resource' do
+        assert_request_requested a_get('/api/1/companies/-1')
+      end
+
+      it 'should can be able to create instance' do
+        expect(@responses).to include('company')
+      end
+
+      describe 'should be get information of item for the company'  do
+        subject { @responses['company'] }
+
+        it { is_expected.not_to be_nil }
+        it { is_expected.to include('id') }
+        it { is_expected.to include('name') }
+        it { is_expected.to include('name_kana') }
+        it { is_expected.to include('display_name') }
+        it { is_expected.to include('role') }
+      end
+    end
   end
 end