freee-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82d36d56f1a7b4aadbdf407ab6b7e712ba834901
-  data.tar.gz: 23df30100a0a669d61be8401f2b7e68c3ea27515
+  metadata.gz: 3ac6dad00c2bdbed672ed5a8f4e6fa8535072d25
+  data.tar.gz: 00010024ac61044692801d3d25c1e4a2c9c8b18d
 SHA512:
-  metadata.gz: b4bc3e0ca9c408f23e265e6f7d301c05a884dc82abc366c5deab031a875f92e44e5e05d24ce9fd8813c1e3729cb0f0d157e3d65e454f2862b67a1b8f349d1ab3
-  data.tar.gz: 1a70475ac783a51e7e093aa917280f766606e09cb28f1deedc976f1134cac267a2f4fc9ae20b5b815eb1b9d1260e737e9aff64c0173a4fb42cc65be5e92c12f2
+  metadata.gz: 963fc0b7ff8de81548e1cc4264c56efc189e731e983974a43300080073a0c7df14d16d06047289020aa03dc1f0a46ce61c80e589f0d321bb176f9711204cb007
+  data.tar.gz: 769e089ea72d5b0e10da3a332c25224b71b430d3988a0fc43ddd8258871ce74d56872e5f7e0eb2f0c94e8711fd191e71534959d467ba2256055dfafe7692d380

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    freee-api (0.0.2)
+    freee-api (0.0.3)
       faraday (~> 0.12.2)
       faraday_middleware (~> 0.12.2)
       oauth2 (~> 1.4.0)
@@ -65,6 +65,7 @@ GEM
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
     unicode-display_width (1.4.0)
+    yard (0.9.15)
 
 PLATFORMS
   ruby
@@ -76,6 +77,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop (~> 0.58.1)
+  yard (~> 0.9.15)
 
 BUNDLED WITH
    1.16.3

data/README.md

@@ -10,7 +10,7 @@ freeeとの通信プロトコルはOAuth2を利用しています。
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'freee-api'
+gem 'freee/api'
 ```
 
 And then execute:
@@ -23,7 +23,14 @@ Or install it yourself as:
 
 ## Usage
 
-編集中...
+### 事前準備
+
+freee APIを利用するためには、事前に利用するアプリケーションをfreeeに登録する必要があります。
+開発者のアカウントで[会計freee](https://secure.freee.co.jp/users/login)にログインし、https://secure.freee.co.jp/oauth/applications にアクセスし、「+新しいアプリケーションを登録」をクリックします。
+アプリケーションを登録することで表示されるアプリケーションIDとSecretが必要になります。
+
+詳しくは以下をご覧ください。
+[https://support.freee.co.jp/hc/ja/articles/115000145263-freee-API%E3%81%AE%E3%82%A2%E3%82%AF%E3%82%BB%E3%82%B9%E3%83%88%E3%83%BC%E3%82%AF%E3%83%B3%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B#1](https://support.freee.co.jp/hc/ja/articles/115000145263-freee-API%E3%81%AE%E3%82%A2%E3%82%AF%E3%82%BB%E3%82%B9%E3%83%88%E3%83%BC%E3%82%AF%E3%83%B3%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B#1)
 
 ## Development
 

data/freee-api.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.6.0'
   spec.add_development_dependency 'rubocop', '~> 0.58.1'
+  spec.add_development_dependency 'yard', '~> 0.9.15'
 
   spec.add_dependency 'oauth2', '~> 1.4.0'
   spec.add_dependency 'faraday', '~> 0.12.2'

data/lib/freee/api/version.rb

@@ -2,6 +2,6 @@
 
 module Freee
   module Api
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/lib/freee/partners/client.rb

@@ -3,11 +3,14 @@
 module Freee
   module Api
     class Partners
+      # Freee API URL
       SITE = 'https://api.freee.co.jp'
       SITE.freeze
+      # 取引先作成URL(POST)
       POST = '/api/1/partners'
       POST.freeze
 
+      # A new instance of HTTP Client.
       def initialize
         @client = Faraday.new(url: SITE) do |faraday|
           faraday.request :json
@@ -16,12 +19,21 @@ module Freee
         end
       end
 
+      # 取引先の作成
+      # https://developer.freee.co.jp/docs/accounting/reference#operations-Partners-post_api_1_partners
+      # @param access_token [String] アクセストークン
+      # @param params [Hash] 新規作成用の取引先パラメータ
+      # @return [Hash] 取引先の結果
       def create_partner(access_token, params)
         @client.authorization :Bearer, access_token
-        @client.post do |req|
+        response = @client.post do |req|
           req.url POST
           req.body = params.to_json
         end
+        case response.status
+        when 401
+          raise 'Unauthorized', response.body
+        end
       end
     end
   end

data/lib/freee/token/client.rb

@@ -3,44 +3,84 @@
 module Freee
   module Api
     class Token
+      # oauth-xx client(read only)
       attr_reader :client
+      # Freee API URL
       SITE = 'https://api.freee.co.jp'
       SITE.freeze
+      # Freee 開発環境用認証コードURL
       DEVELOPMENT_REDIRECT_URL = 'urn:ietf:wg:oauth:2.0:oob'
       DEVELOPMENT_REDIRECT_URL.freeze
+      # Freee 認証コードURL
       AUTHORIZE_URL = 'https://secure.freee.co.jp/oauth/authorize'
       AUTHORIZE_URL.freeze
+      # Freee Token URL
       TOKEN_URL = '/oauth/token'
       TOKEN_URL.freeze
 
+      # A new instance of OAuth2 Client.
+      # @param app_id [String] Application ID
+      # @param secret [String] Secret
       def initialize(app_id, secret)
         options = {
           site: SITE,
           authorize_url: AUTHORIZE_URL,
           token_url: TOKEN_URL
         }
+
+        raise 'アプリケーションIDが入力されていません' if app_id.empty?
+
+        raise 'Secretが入力されていません' if secret.empty?
         @client = OAuth2::Client.new(app_id, secret, options)
       end
 
+      # 開発環境用に認証コード・アクセストークンのコールバックURLを生成
+      # @return [String] Freee 開発環境用認証コード・アクセストークン取得用URL
       def development_authorize
         @client.auth_code.authorize_url(redirect_uri: DEVELOPMENT_REDIRECT_URL)
       end
 
+      # 本番環境用に認証コード・アクセストークンのコールバックURLを生成
+      # @param redirect_uri [String] redirect_url for Authentication Code
+      # @return [String] Freee 本番環境用認証コードURL
       def authorize(redirect_uri)
+        raise '認証用コードを返すためのリダイレクトURLが指定されていません' if redirect_uri.empty?
         @client.auth_code.authorize_url(redirect_uri: redirect_uri)
       end
 
+      # アクセストークン関係のパラメータを取得
+      # @param code [String] Authentication Code
+      # @param redirect_uri [String] redirect_url for Access Token
+      # @return [Hash] アクセストークン
       def get_access_token(code, redirect_uri)
-        @client.auth_code.get_token(code, redirect_uri: redirect_uri)
+        raise '認証用コードが存在しません' if code.empty?
+        raise 'アクセストークンを返すためのリダイレクトURLが指定されていません' if redirect_uri.empty?
+        begin
+          @client.auth_code.get_token(code, redirect_uri: redirect_uri)
+        rescue OAuth2::Error
+          raise 'アクセストークンの取得に失敗しました。次の原因が考えられます。原因: 不明なクライアント、クライアント認証が含まれていない、認証コードが不正、認証コードが無効、リダイレクトURLが不正、別のクライアントに適用されている。'
+        end
       end
 
+      # リフレッシュトークンからアクセストークンを再取得
+      # @param access_token [String] Access Token
+      # @param refresh_token [String] Refresh Token
+      # @param expires_at [Integer] アクセストークンの有効期限(UNIX TIME)
+      # @return [Hash] アクセストークン
       def refresh_token(access_token, refresh_token, expires_at)
+        raise 'アクセストークンが存在しません' if access_token.empty?
+        raise 'アクセストークンの有効期限が指定されていません' if expires_at.nil?
+        raise 'リフレッシュトークンが存在しません' if refresh_token.empty?
         params = {
           refresh_token: refresh_token,
           expires_at: expires_at
         }
         @access_token = OAuth2::AccessToken.new(@client, access_token, params)
-        @access_token.refresh! if @access_token.expired?
+        begin
+          @access_token.refresh! if @access_token.expired?
+        rescue OAuth2::Error
+          raise 'アクセストークンの取得に失敗しました。次の原因が考えられます。原因: 不明なクライアント、アクセストークンが不正、リフレッシュトークンが不正、有効期限が不正。'
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freee-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - himrock922
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-22 00:00:00.000000000 Z
+date: 2018-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.58.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.15
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.15
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement