apigw 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8493d32a5105e968cbe8a2386e0f6fc8f3b12914
+  data.tar.gz: f6fed6db1ba06db25395b3d7cb459348d6a6ef5d
+SHA512:
+  metadata.gz: 1dd5ac799c8aa241091680fdf24b727c607d81978555ffb2495ec89a3185c8b668e91e04b389f49ee935d129a793679453fc42d7d22b0da8c6f7da5a910510ae
+  data.tar.gz: b07d677f426f6bdf24e35cce1c58155a32f8864aab60e861505040d65fc17f74397a079df1609d5de4a587ace7ce5cc917f91c613c8a604947a1f1149d4c0320

data/README.md

@@ -0,0 +1,130 @@
+NTT Communications API SDK(ruby)
+===
+
+このライブラリは、NTT Communications APIsと対話的にアクセスするための簡易的なラッパーを提供します。
+各APIの仕様については、[デベロッパーポータル](https://developer.ntt.com/ja)のドキュメントを参照ください。
+
+セットアップ
+---
+
+### Bundler での使用
+
+Gemfile に下記を追記し、`bundle install`
+
+```ruby
+gem 'apigw'
+```
+
+システム要件
+---
+
+Ruby 2.0.0 以上
+
+使い方
+---
+
+2015/10現在、クライアントは
+
+* OAuth API
+* Business Process API
+* APILog API
+* IAM API
+
+の4つのAPIへのアクセスを提供します。
+
+### クライアントの生成
+
+クライアントの生成時には、エンドポイントの情報を記載したYAML形式の設定ファイルへのパスを指定します。
+
+```ruby
+client = ApiGW::Client.new(config_path: 'path/to/config.yml', environment: 'development')
+```
+
+設定ファイル例:
+
+```yaml
+development:
+  host: "ホスト名"(e.g. 'https://api.ntt.com/')
+  api_version: "APIバージョン"(e.g. 'v1')
+  timeout: タイムアウト(ms)
+  verify_ssl: SSL証明書の検証を行うか(true / false)
+  debuggable: デバッグ情報を表示するか(true / false)
+```
+
+※ host と api_version は必須となります。
+
+### アクセストークンの取得
+
+[デベロッパーポータル](https://developer.ntt.com/ja) にて払い出されたコンシューマーキーとシークレットキーを指定します。
+
+```ruby
+response = client.oauth('コンシューマーキー', 'シークレットキー').access_token
+access_token = response.body['accessToken']
+```
+
+全てのAPIのレスポンスは [Faraday::Response](https://github.com/lostisland/faraday/blob/master/lib/faraday/response.rb) オブジェクトで返却されます。
+レスポンスのJSONは `Faraday::Response#body` からHash形式にパースされた状態で取得できます。
+各APIのレスポンス仕様については、[デベロッパーポータル](https://developer.ntt.com/ja)のドキュメントを参照ください。
+
+### Business Process API
+
+OAuth API にて取得したアクセストークンとAPIパス、サービス名称を指定します。
+
+```ruby
+response = client.business_process('アクセストークン').get('contracts', 'サービス名称')
+items = response.body['items']
+```
+
+情報の参照には `ApiGW::BusinessProcess#get(...)` を、各種オーダには `ApiGW::BusinessProcess#post(...)` を利用します。
+
+### APILog API
+
+OAuth API にて取得したアクセストークンと利用履歴の対象日を指定します。
+
+```ruby
+response = client.api_log('アクセストークン').get('日付(YYYYMMDD)')
+records = response.body['Records']
+```
+
+### その他API
+
+examples/を参考にしてください。
+
+ApiGW::ApiBase の継承について
+---
+
+新しいAPIに対応したクラスを作成する場合は、`ApiGW::ApiBase`のサブクラスを実装します。
+以下のドキュメント及び `ApiGW::BusinessProcess` や `ApiGW::ApiLog` を参考に実装してください。
+
+### 実装が必要なクラスメソッド
+
+#### `api_name()`
+
+APIの名称を返すメソッドです。
+
+`https://api.ntt.com/v1/xxxxxx/yyyyyy` の `xxxxxx` の部分を返します。
+例えば `ApiGW::BusinessProcess` では `business-process` 、 `ApiGW:ApiLog` では `apilog` を返すよう実装されています。
+
+api_name をオーバーライドしないと NotImplementedError が発生します。
+
+#### `require_authorization?()`
+
+このAPIに認証(アクセストークン)が必要かを返します。デフォルトでは false です。
+
+trueを返すようにすると、リクエストヘッダーに `Authorization` を自動で付加するようになります。
+
+### リクエスト時に使用するインスタンスメソッド
+
+#### `XXX_request(path, opts = {})`
+
+`get_request`, `post_request`, `put_request`, `delete_request`, `options_request` の5つが定義されています。
+それぞれ GET, POST, PUT, DELETE, OPTIONS のリクエストを実行し、結果を返します。
+
+`path` は `https://api.ntt.com/v1/xxxxxx/yyyyyy` の `yyyyyy` の部分を渡します。
+`yyyyyy` に相当するパスがないAPIの場合、 `nil` を指定します。
+
+
+ライセンス
+---
+Copyright © 2015 NTT Communications  
+[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

data/apigw.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apigw/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apigw"
+  spec.version       = ApiGW::VERSION
+  spec.authors       = ["NTT Communications APIGateway Teams"]
+  spec.email         = ["apigateway@ntt.com"]
+
+  spec.summary       = %q{NTT Communications APIGateway SDK}
+  spec.description   = %q{NTT Communications APIGateway SDK}
+  spec.homepage      = "https://github.com/nttcom/apigw-ruby-sdk"
+
+  spec.files = Dir["README.md", "lib/**/*.rb", "*.gemspec" ]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+end

data/lib/apigw.rb

@@ -0,0 +1,9 @@
+module ApiGW
+  require "apigw/version"
+  require "apigw/client"
+  require "apigw/api_base"
+  require "apigw/oauth"
+  require "apigw/business_process"
+  require "apigw/api_log"
+  require "apigw/iam"
+end

data/lib/apigw/api_base.rb

@@ -0,0 +1,53 @@
+# coding: utf-8
+module ApiGW
+
+  class ApiBase
+
+    class << self
+      def api_name
+        raise NotImplementedError
+      end
+
+      def require_authorization?
+        false
+      end
+    end
+
+    def initialize(client, opts = {})
+      @client       = client
+      @consumer_key = opts[:consumer_key]
+      @secret_key   = opts[:secret_key]
+      @access_token = opts[:access_token]
+    end
+
+    # メソッドをまとめて定義
+    [:get, :post, :put, :delete, :options].each do |verb|
+      define_method "#{verb}_request" do |path, opts = {}|
+        request verb, path, opts
+      end
+    end
+
+    private
+
+    def request(method, path, opts = {})
+      clz = self.class
+
+      url = path.nil? ? clz.api_name : "#{clz.api_name}/#{path}"
+
+      opts_copy = Marshal.load Marshal.dump(opts)
+      if clz.require_authorization?
+        apply_authorization_header_to_opts! opts_copy
+      end
+
+      @client.send_request method, url, opts_copy
+    end
+
+    def apply_authorization_header_to_opts!(opts)
+      headers = opts[:headers] || {}
+      headers['Authorization'] = "Bearer #{@access_token}"
+      opts[:headers] = headers
+    end
+
+  end
+
+end

data/lib/apigw/api_log.rb

@@ -0,0 +1,24 @@
+module ApiGW
+
+  class ApiLog < ApiBase
+
+    class << self
+      def api_name
+        'apilog'
+      end
+
+      def require_authorization?
+        true
+      end
+    end
+
+    def get(target_date)
+     querys = {
+        targetDate: target_date
+      }
+      get_request nil, querys: querys
+    end
+
+  end
+
+end

data/lib/apigw/business_process.rb

@@ -0,0 +1,37 @@
+module ApiGW
+
+  class BusinessProcess < ApiBase
+
+    class << self
+      def api_name
+        'business-process'
+      end
+
+      def require_authorization?
+        true
+      end
+    end
+
+    def get(path, service_name, opts = {})
+      get_request path, apply_service_name_to_opts(opts, service_name)
+    end
+
+    def post(path, service_name, data, opts = {})
+      opts_copy = Marshal.load Marshal.dump(opts)
+      opts_data = opts_copy[:data] || {}
+      opts_copy[:data] = opts_data.merge data
+      post_request path, apply_service_name_to_opts(opts_copy, service_name)
+    end
+
+    private
+
+    def apply_service_name_to_opts(opts, service_name)
+      opts_copy = Marshal.load Marshal.dump(opts)
+      querys = opts_copy[:querys] || {}
+      querys['serviceName'] = service_name
+      opts_copy[:querys] = querys
+      return opts_copy
+    end
+
+  end
+end

data/lib/apigw/client.rb

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+module ApiGW
+
+  require 'apigw/logger'
+  require 'yaml'
+  require 'faraday'
+  require 'faraday_middleware'
+
+  class Client
+
+    DEFAULT_CONFIG = {
+      timeout: 30000,
+      verify_ssl: false,
+      debuggable: false
+    }
+
+    def initialize(opts = {})
+      if opts.include?(:config_path) && opts.include?(:environment)
+        # YAMLから取得したHashはキーがシンボルではなく文字列なので、キーをシンボルに直す必要あり
+        cfg_all = YAML.load_file opts[:config_path]
+        cfg = cfg_all[opts[:environment].to_s]
+        cfg.keys.each do |key|
+          cfg[key.to_sym] = cfg.delete key
+        end
+        config = cfg
+      elsif opts.include?(:config)
+        # こっちはキーがシンボルである想定
+        config = opts[:config]
+      else
+        config = {}
+      end
+
+      @host = config[:host]
+      if @host.nil?
+        raise "Configuration 'host' is not found."
+      end
+
+      @api_version = config[:api_version]
+      if @api_version.nil?
+        raise "Configuration 'api_version' is not found."
+      end
+
+      @verify_ssl = config[:verify_ssl] || DEFAULT_CONFIG[:verify_ssl]
+      @timeout = config[:timeout] || DEFAULT_CONFIG[:timeout]
+      @debuggable = config[:debuggable] || DEFAULT_CONFIG[:debuggable]
+    end
+
+    def oauth(consumer_key, secret_key)
+      ApiGW::OAuth.new self, consumer_key: consumer_key, secret_key: secret_key
+    end
+
+    def business_process(access_token)
+      ApiGW::BusinessProcess.new self, access_token: access_token
+    end
+
+    def api_log(access_token)
+      ApiGW::ApiLog.new self, access_token: access_token
+    end
+
+    def iam(access_token)
+      ApiGW::Iam.new self, access_token: access_token
+    end
+
+    def send_request(method, path, opts = {})
+      opts_copy = Marshal.load Marshal.dump(opts)
+      querys = opts_copy[:querys]
+      data = opts_copy[:data]
+      headers = opts_copy[:headers] || {}
+
+      headers[:accept] ||= "application/json"
+      headers[:accept_encoding] ||= "gzip, deflate"
+      headers[:connection] ||= "Keep-Alive"
+      headers[:host] ||= @host.split("://")[1]
+
+      unless method == :get
+        if data
+          headers[:content_length] ||= JSON.generate(data).length.to_s
+        else
+          headers[:content_length] ||= "0"
+        end
+      end
+
+      headers[:user_agent] ||= "apigw/#{VERSION}"
+
+      connection = Faraday.new("#{@host}/#{@api_version}") do |c|
+        # 順番を変えると正しく動かないので順番を変えないこと
+        c.request :json
+        c.response :json
+        if @debuggable
+          # デバッグモード時はカスタムロガーとカスタムアダプターを使用
+          c.use ApiGW::Logger
+          c.use ApiGW::NetHttp
+        else
+          c.adapter :net_http
+        end
+        c.ssl.verify = @verify_ssl
+      end
+
+      # Faradayのタイムアウトは秒単位
+      timeout_sec = @timeout / 1000
+      response = connection.run_request method, path, data, headers do |r|
+        r.params = querys unless querys.nil?
+        r.options.timeout = timeout_sec
+        r.options.open_timeout = timeout_sec
+      end
+
+      return response
+    end
+
+  end
+
+end

data/lib/apigw/iam.rb

@@ -0,0 +1,44 @@
+module ApiGW
+
+  class Iam < ApiBase
+
+    class << self
+      def api_name
+        'iam'
+      end
+
+      def require_authorization?
+        true
+      end
+    end
+
+    def get(path, opts = {})
+      get_request path, opts
+    end
+
+    def post(path, data)
+      opts_copy = {}
+      opts_data = opts_copy[:data] || {}
+      opts_copy[:data] = data
+      post_request path, opts_copy
+    end
+
+    def put(path)
+      put_request path
+    end
+
+    def delete(path)
+      delete_request path
+    end
+
+    private
+
+    def apply_service_name_to_opts(opts)
+      opts_copy = Marshal.load Marshal.dump(opts)
+      querys = opts_copy[:querys] || {}
+      opts_copy[:querys] = querys
+      return opts_copy
+    end
+
+  end
+end

data/lib/apigw/logger.rb

@@ -0,0 +1,61 @@
+# coding: utf-8
+module ApiGW
+
+  require 'faraday'
+  require 'json'
+
+  class NetHttp < Faraday::Adapter::NetHttp
+    # オーバーライドして :http_version と :message をenvに入れておく
+    def perform_request(http, env)
+      http_response = super
+      env[:http_version] = http_response.http_version
+      env[:message] = http_response.message
+      http_response
+    end
+  end
+
+  class Logger < Faraday::Response::Middleware
+
+    def call(env)
+      lines = [ "" ]
+      if env.url.query.nil?
+        path = env.url.path
+      else
+        path = "#{env.url.path}?#{env.url.query}"
+      end
+      lines << "#{env.method.upcase} #{path} HTTP/1.1"
+      env.request_headers.keys.sort.each do |key|
+        lines << "#{key}: #{env.request_headers[key]}"
+      end
+      lines << pretty_json(env.body)
+      lines << ""
+
+      @app.call(env).on_complete do
+        lines << "HTTP/#{env[:http_version]} #{env.status} #{env[:message]}"
+        env.response_headers.keys.sort.each do |key|
+          lines << "#{key}: #{env.response_headers[key]}"
+        end
+        lines << pretty_json(env.body)
+        puts lines.join "\n"
+      end
+
+    end
+
+    private
+
+    def pretty_json(input)
+      if input.nil?
+        return ''
+      end
+      begin
+        # TODO inputがunicodeエスケープされててもパースされてしまう
+        return JSON.pretty_generate(JSON.parse(input))
+      rescue
+        # pass
+      end
+      return input
+    end
+
+  end
+
+end

data/lib/apigw/oauth.rb

@@ -0,0 +1,22 @@
+module ApiGW
+
+  class OAuth < ApiBase
+
+    class << self
+      def api_name
+        'oauth'
+      end
+    end
+
+    def access_token
+      data = {
+        clientId: @consumer_key,
+        clientSecret: @secret_key,
+        grantType: 'client_credentials'
+      }
+      post_request 'accesstokens', data: data
+    end
+
+  end
+
+end

data/lib/apigw/version.rb

@@ -0,0 +1,3 @@
+module ApiGW
+  VERSION = "1.0.1"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: apigw
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- NTT Communications APIGateway Teams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday_middleware
+  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'
+description: NTT Communications APIGateway SDK
+email:
+- apigateway@ntt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- apigw.gemspec
+- lib/apigw.rb
+- lib/apigw/api_base.rb
+- lib/apigw/api_log.rb
+- lib/apigw/business_process.rb
+- lib/apigw/client.rb
+- lib/apigw/iam.rb
+- lib/apigw/logger.rb
+- lib/apigw/oauth.rb
+- lib/apigw/version.rb
+homepage: https://github.com/nttcom/apigw-ruby-sdk
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: NTT Communications APIGateway SDK
+test_files: []