freee 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b2631505ab67787214e0cf2b427768a67646bf2
-  data.tar.gz: 02082178199c8787d1ccd2faee4c64ba60251d4d
+  metadata.gz: 7553a7f12177b2231a3857a57d0f478bbc7db57f
+  data.tar.gz: e3ad6a1d35ab04daed124a24cc425296da48ddf6
 SHA512:
-  metadata.gz: 15fbd6076543ddb79baf77e36a915e28436cdb3368e50d0708cf6bace7a0b6e18565e16156c0a9b494d3f49765833294b1265b40afad7699015181e869890e9f
-  data.tar.gz: 567bd1ebcb165d27be4a88411ecd5fa486e2e338f88eba2fbaa17faba3902c6fbf555128b54617bedec75c236d8c50e13c507463a550a5142314f9c5d2dcf986
+  metadata.gz: 357b72ff2086975b4162e8c784d884f2934f5d5f1b56af3b40e05b8430a527f1845a525b53a10493d68a83159dac743f9e1320c20c814f52b71fccf1fa2f4b9a
+  data.tar.gz: c2bb1afbe46044d67400ffc92500854f49d92b856b95033309fcac34568da7ba23ca3c811c11e662c6d891cbd6607a856554f2d6e184ab7bb5db897ecd0f6a32

data/README.md

@@ -18,14 +18,18 @@ Or install it yourself as:
 
 ## Usage
 
-```ruby
-require 'freee'
-
-Freee::Base.config("#{client_id}", "#{secret_key}", "#{token}")
-Freee::User.new.me
+```sh
+> export FREEE_CLIENT_ID=XXXXX
+> export FREEE_SECRET_KEY=XXXXX
+> export FREEE_APPLICATION_TOKEN=XXXXX
+> irb
+> require 'freee'
+> Freee::Base.set_env
+> Freee::User.me
+{"user"=>{"email"=>"hoge@example.com", "display_name"=>nil, "first_name"=>nil, "last_name"=>nil, "first_name_kana"=>nil, "last_name_kana"=>nil}}
 ```
 
-### Create token
+### Generate token
 
 ```
 > freee token

data/freee.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'faraday_middleware'
   spec.add_runtime_dependency 'httpauth'
   spec.add_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'activesupport'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'

data/lib/freee/account.rb

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

data/lib/freee/amount.rb

@@ -1,7 +1,7 @@
 module Freee
   class Amount < Freee::Base
     def self.current_report
-      Freee.client.get('/api/p/reports/amounts/current')
+      Freee.client.get('/api/p/reports/amounts/current', :amount)
     end
   end
 end

data/lib/freee/base.rb

@@ -1,10 +1,20 @@
-module Freee
+require 'uri'
 
+module Freee
   def client
     Base.new.client
   end
   module_function :client
 
+  def encode_params(kwargs)
+    if kwargs.length != 0
+      '&' + URI.encode_www_form(kwargs)
+    else
+      ''
+    end
+  end
+  module_function :encode_params
+
   class Base
 
     @@client_id = nil
@@ -40,8 +50,9 @@ module Freee
       @@token = token
     end
 
-    def get(path)
-      @client.get(path).response.env[:body]
+    def get(path, type=nil)
+      response = @client.get(path).response.env[:body]
+      return Freee::Response::Type.convert(response, type)
     end
 
     private

data/lib/freee/company.rb

@@ -5,11 +5,11 @@ module Freee
     end
 
     def self.list
-      Freee.client.get('/api/1/companies')
+      Freee.client.get('/api/1/companies', :company)
     end
 
     def self.list_of_details(company_id)
-      Freee.client.get("/api/1/companies/#{company_id.to_i}")
+      Freee.client.get("/api/1/companies/#{company_id.to_i}", :company)
     end
   end
 end

data/lib/freee/deal.rb

@@ -4,8 +4,22 @@ module Freee
       #client.post('/api//1/deals')
     end
 
-    def self.list(company_id)
-      Freee.client.get("/api/1/deals?company_id=#{company_id.to_i}")
+    def self.list(company_id, **kwargs)
+      params = Freee.encode_params(kwargs)
+      Freee.client.get(
+        "/api/1/deals?company_id=#{company_id.to_i}#{params}",
+        :deal
+      )
+    end
+
+    def self.list_income(company_id, **kwargs)
+      kwargs[:type] = 'income'
+      self.list(company_id, **kwargs)
+    end
+
+    def self.list_expense(company_id, **kwargs)
+      kwargs[:type] = 'expense'
+      self.list(company_id, **kwargs)
     end
   end
 end

data/lib/freee/item.rb

@@ -5,7 +5,10 @@ module Freee
     end
 
     def self.list(company_id)
-      Freee.client.get("/api/1/items?company_id=#{company_id.to_i}")
+      Freee.client.get(
+        "/api/1/items?company_id=#{company_id.to_i}",
+        :item
+      )
     end
   end
 end

data/lib/freee/obj/account.rb

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

data/lib/freee/obj/amount.rb

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

data/lib/freee/obj/company.rb

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

data/lib/freee/obj/deal.rb

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

data/lib/freee/obj/item.rb

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

data/lib/freee/obj/partner.rb

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

data/lib/freee/obj/response.rb

@@ -0,0 +1,37 @@
+require 'active_support/inflector'
+
+module Freee::Response
+  class Base
+    attr_reader :val
+
+    def initialize(val)
+      @val = Hash.try_convert(val)
+    end
+
+    def method_missing(name, *args)
+      @val[name.to_s]
+    end
+
+    def [](name)
+      @val[name.to_s]
+    end
+
+    def has_key?(name)
+      if @val[name.to_s]
+        return true
+      else
+        return false
+      end
+    end
+    alias_method :key, :has_key?
+    alias_method :include?, :has_key?
+    alias_method :member?, :has_key?
+  end
+
+  class Type
+    def self.convert(response, type=nil)
+      klass = "Freee::Response::#{type.to_s.capitalize}".constantize
+      klass.new(response)
+    end
+  end
+end

data/lib/freee/obj/tax.rb

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

data/lib/freee/obj/transfer.rb

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

data/lib/freee/obj/user.rb

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

data/lib/freee/obj/wallet.rb

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

data/lib/freee/obj/walletable.rb

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

data/lib/freee/partner.rb

@@ -5,7 +5,10 @@ module Freee
     end
 
     def self.list(company_id)
-      Freee.client.get("/api/1/partners?company_id=#{company_id.to_i}")
+      Freee.client.get(
+        "/api/1/partners?company_id=#{company_id.to_i}",
+        :partner
+      )
     end
   end
 end

data/lib/freee/tax.rb

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

data/lib/freee/transfer.rb

@@ -4,8 +4,12 @@ module Freee
       #client.post('/api/1/transfers')
     end
 
-    def self.list(company_id)
-      Freee.client.get("/api/1/transfers?company_id=#{company_id.to_i}")
+    def self.list(company_id, **kwargs)
+      params = Freee.encode_params(kwargs)
+      Freee.client.get(
+        "/api/1/transfers?company_id=#{company_id.to_i}#{params}",
+        :transfer
+      )
     end
   end
 end

data/lib/freee/user.rb

@@ -1,11 +1,11 @@
 module Freee
   class User < Freee::Base
     def self.me
-      Freee.client.get('/api/1/users/me')
+      Freee.client.get('/api/1/users/me', :user)
     end
 
     def self.me_all
-      Freee.client.get('/api/1/users/me?companies=true')
+      Freee.client.get('/api/1/users/me?companies=true', :user)
     end
   end
 end

data/lib/freee/version.rb

@@ -1,3 +1,3 @@
 module Freee
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/lib/freee/wallet.rb

@@ -4,8 +4,12 @@ module Freee
       #client.post('/api/1/wallet_txns')
     end
 
-    def self.list(company_id)
-      Freee.client.get("/api/1/wallet_txns?company_id=#{company_id.to_i}")
+    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
+      )
     end
   end
 end

data/lib/freee/walletable.rb

@@ -1,7 +1,10 @@
 module Freee
   class Walletable < Freee::Base
     def self.list(company_id)
-      Freee.client.get("/api/1/walletables?company_id=#{company_id.to_i}")
+      Freee.client.get(
+        "/api/1/walletables?company_id=#{company_id.to_i}",
+        :walletable
+      )
     end
   end
 end

data/lib/freee.rb

@@ -20,6 +20,19 @@ require 'freee/util'
 require 'freee/wallet'
 require 'freee/walletable'
 
+require 'freee/obj/response'
+require 'freee/obj/account'
+require 'freee/obj/amount'
+require 'freee/obj/company'
+require 'freee/obj/deal'
+require 'freee/obj/item'
+require 'freee/obj/partner'
+require 'freee/obj/tax'
+require 'freee/obj/transfer'
+require 'freee/obj/user'
+require 'freee/obj/wallet'
+require 'freee/obj/walletable'
+
 module Freee
   OPTIONS = {
     site: 'https://api.freee.co.jp',

data/spec/account_spec.rb

@@ -18,6 +18,7 @@ describe Freee::Account do
   describe 'should be get information of account' do
     subject { account.items(company_id) }
     it { is_expected.to include('account_items') }
+    it { is_expected.to be_instance_of(Freee::Response::Account) }
   end
 
   describe 'should be get information of account_items' do

data/spec/amount_spec.rb

@@ -10,8 +10,10 @@ describe Freee::Amount do
     Freee::Base.config(client_id, secret_key, token)
   end
 
-  it 'should can be able to create instance' do
-    expect(amount.current_report).not_to be_nil
+  describe 'should can be able to create instance' do
+    subject { amount.current_report }
+    it { is_expected.not_to be_nil }
+    it { is_expected.to be_instance_of(Freee::Response::Amount) }
   end
 
   describe 'should be get information of amount by current' do

data/spec/company_spec.rb

@@ -11,8 +11,10 @@ describe Freee::Company do
     Freee::Base.config(client_id, secret_key, token)
   end
 
-  it 'should can be able to create instance' do
-    expect(company.list).not_to be_nil
+  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

data/spec/deal_spec.rb

@@ -11,8 +11,10 @@ describe Freee::Deal do
     Freee::Base.config(client_id, secret_key, token)
   end
 
-  it 'should can be able to create instance' do
-    expect(deal.list(company_id)).not_to be_nil
+  describe 'should can be able to create instance' do
+    subject { deal.list(company_id) }
+    it { is_expected.not_to be_nil }
+    it { is_expected.to be_instance_of(Freee::Response::Deal) }
   end
 
   describe 'should get deals for the company' do
@@ -57,4 +59,50 @@ describe Freee::Deal do
     it { is_expected.to include('from_walletable_id') }
     it { is_expected.to include('amount') }
   end
+
+  describe 'should get payments from deals for the company with start_due_date' do
+    subject do
+      result = deal.list(company_id, start_due_date: '2014-06-25')['deals']
+      __memoize = result
+
+      result.select! { |x| x['due_date'] >= '2014-06-25' }
+      result.map! { |x| x['due_date'] }
+
+      __memoize.map! { |x| x['due_date'] }
+
+      result.length == __memoize.length
+    end
+
+    it { is_expected.not_to be_nil }
+    it { is_expected.to be_truthy }
+  end
+
+  describe 'should get payments from future deals for the company with start_due_date' do
+    subject { deal.list(company_id, start_due_date: '2099-12-31')['deals'] }
+
+    it { is_expected.not_to be_nil }
+    it { is_expected.to eq [] }
+  end
+  
+  describe 'should get payments for deals with income' do
+    subject do
+      result = deal.list_income(company_id)['deals'] 
+      result.map! { |x| x['type'] == 'income' }
+      Set.new(result).length
+    end
+
+    it { is_expected.not_to be_nil }
+    it { is_expected.to eq 1 }
+  end
+
+  describe 'should get payments for deals with outcome' do
+    subject do
+      result = deal.list_expense(company_id)['deals'] 
+      result.map! { |x| x['type'] == 'expense' }
+      Set.new(result).length
+    end
+
+    it { is_expected.not_to be_nil }
+    it { is_expected.to eq 1 }
+  end
 end

data/spec/item_spec.rb

@@ -11,8 +11,10 @@ describe Freee::Item do
     Freee::Base.config(client_id, secret_key, token)
   end
 
-  it 'should can be able to create instance' do
-    expect(item.list(company_id)).not_to be_nil
+  describe 'should can be able to create instance' do
+    subject { item.list(company_id) }
+    it { is_expected.not_to be_nil }
+    it { is_expected.to be_instance_of(Freee::Response::Item) }
   end
 
   describe 'should get information of first item for the company' do

data/spec/partner_spec.rb

@@ -12,7 +12,9 @@ describe Freee::Partner do
   end
 
   it 'should can be able to create instance' do
-    expect(partner.list(company_id)).not_to be_nil
+    subject { partner.list(company_id) }
+    it { is_expected.not_to be_nil }
+    it { is_expected.to be_instance_of(Freee::Response::Partner) }
   end
 
   describe 'should get partners of first item for the company' do

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 $:.unshift(File.realpath(File.dirname(__FILE__) + '/../lib'))
 
 require 'freee'

data/spec/tax_spec.rb

@@ -11,8 +11,10 @@ describe Freee::Tax do
     Freee::Base.config(client_id, secret_key, token)
   end
 
-  it 'should can be able to create instance' do
-    expect(tax.list(company_id)).not_to be_nil
+  describe 'should can be able to create instance' do
+    subject { tax.list(company_id) }
+    it { is_expected.not_to be_nil }
+    it { is_expected.to be_instance_of(Freee::Response::Tax) }
   end
 
   describe 'should get item of tax for the company' do

data/spec/transfer_spec.rb

@@ -11,8 +11,10 @@ describe Freee::Transfer do
     Freee::Base.config(client_id, secret_key, token)
   end
 
-  it 'should be able to get client' do
-    expect(transfer.list(company_id)).not_to be_nil
+  describe 'should be able to get client' do
+    subject { transfer.list(company_id) }
+    it { is_expected.not_to be_nil }
+    it { is_expected.to be_instance_of(Freee::Response::Transfer) }
   end
 
   it 'should be get information of transfers for the company' do
@@ -33,4 +35,11 @@ describe Freee::Transfer do
     it { is_expected.to include('to_walletable_id') }
     it { is_expected.to include('description') }
   end
+
+  describe "should be get one's information of first transfers for the company" do
+    subject { transfer.list(company_id, limit: 3)['transfers'].length }
+
+    it { is_expected.not_to be_nil }
+    it { is_expected.to eq 3 }
+  end
 end

data/spec/user_spec.rb

@@ -10,10 +10,11 @@ describe Freee::User do
     Freee::Base.config(client_id, secret_key, token)
   end
 
-  it 'should be get information of user' do
-    result = user.me
-    expect(result).to include('user')
-    expect(result['user']).not_to include('companies')
+  describe 'should be get information of user' do
+    subject { user.me }
+    it { is_expected.not_to be_nil }
+    it { is_expected.to be_instance_of(Freee::Response::User) }
+    it { is_expected.to include('user') }
   end
 
   it 'should be get information of user at all' do

data/spec/wallet_spec.rb

@@ -11,8 +11,10 @@ describe Freee::Wallet do
     Freee::Base.config(client_id, secret_key, token)
   end
 
-  it 'should can be able to create instance' do
-    expect(wallet.list(company_id)).not_to be_nil
+  describe 'should can be able to create instance' do
+    subject { wallet.list(company_id) }
+    it { is_expected.not_to be_nil }
+    it { is_expected.to be_instance_of(Freee::Response::Wallet) }
   end
 
   describe 'should get information of wallet txns for the company' do
@@ -36,4 +38,24 @@ describe Freee::Wallet do
     it { is_expected.to include('walletable_type') }
     it { is_expected.to include('walletable_id') }
   end
+
+  describe 'should get information of first wallet txns with walletable type' do
+    subject do
+      result = wallet.list(company_id, walletable_type: 'bank_account')['wallet_txns']
+      result.map! { |x| x['walletable_type'] }
+      Set.new(result).length
+    end
+
+    it { is_expected.not_to be_nil }
+    it { is_expected.to eq 1 }
+  end
+
+  describe "should get information of one's wallet txns" do
+    subject do
+      wallet.list(company_id, limit: 2)['wallet_txns'].length
+    end
+
+    it { is_expected.not_to be_nil }
+    it { is_expected.to eq 2 }
+  end
 end

data/spec/walletable_spec.rb

@@ -11,8 +11,10 @@ describe Freee::Walletable do
     Freee::Base.config(client_id, secret_key, token)
   end
 
-  it 'should can be able to create instance' do
-    expect(walletable.list(company_id)).not_to be_nil
+  describe 'should can be able to create instance' do
+    subject { walletable.list(company_id) }
+    it { is_expected.not_to be_nil }
+    it { is_expected.to be_instance_of(Freee::Response::Walletable) }
   end
 
   describe 'should get information of walletable for the company' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freee
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Keiji Matsuzaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-29 00:00:00.000000000 Z
+date: 2014-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +159,18 @@ files:
 - lib/freee/company.rb
 - lib/freee/deal.rb
 - lib/freee/item.rb
+- lib/freee/obj/account.rb
+- lib/freee/obj/amount.rb
+- lib/freee/obj/company.rb
+- lib/freee/obj/deal.rb
+- lib/freee/obj/item.rb
+- lib/freee/obj/partner.rb
+- lib/freee/obj/response.rb
+- lib/freee/obj/tax.rb
+- lib/freee/obj/transfer.rb
+- lib/freee/obj/user.rb
+- lib/freee/obj/wallet.rb
+- lib/freee/obj/walletable.rb
 - lib/freee/partner.rb
 - lib/freee/tax.rb
 - lib/freee/transfer.rb