openbd 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bc90f5c6b50c5c21e33735636eb7367e2a0c34b
-  data.tar.gz: fece3e8792a65303e00f737145be4b1edd6de1b6
+  metadata.gz: e4def2d8526429b3dc53b183c07ca1eb78f294b8
+  data.tar.gz: 6c5bb89084890943d6a3e81adc1b4793ff177a1e
 SHA512:
-  metadata.gz: a3c7b7fa4deb1ad21bb59750cd091e75678bd9c5e1502c1fceff79f3a2db08d3fba72d79a865de0dacbd2b3507fd30d7a0c2df6d5c03db5d8bf5b2ac98787619
-  data.tar.gz: ab75845f73460bf9e9ef0de488b57e25c08f764ed0be0d0ec46c55c2206c4b8343b5b55f28fc2f5bfbdf1261be83c08fed195d50b774338aaa689e4c39aa20a6
+  metadata.gz: d5c93563a76c5d93e2a096fb9fcf7eb40da328c0ec25a82487a7066917d8b226a6f2c8bdd2d0d6c950954d8ceb2f880dc10b0c2da7f96e1d681332a36eda0c79
+  data.tar.gz: e2737f2de02240fc4fc61f805148fe6992b86b89e2fad5b306750929a6a53dd43da5f3db53286c184d671a01af7729a1dd30f62f73ec2cccb1e9bc4cbfb3f59c

data/.rubocop.yml

@@ -1,7 +1,10 @@
+AllCops:
+  Excludes:
+    - spec/*.rb
+    - 'vendor/**/*'
+
 Style/MutableConstant:
   Enabled: false
-Style/Documentation:
-  Enabled: false
 Style/EmptyLinesAroundModuleBody:
   Enabled: false
 Style/EmptyLinesAroundClassBody:

data/README.md

@@ -31,22 +31,64 @@ client = Openbd::Client.new
 
 # get
 client.get('978-4-7808-0204-7')
+client.get('4-06-2630869,978-4-06-2144490')
+client.get(['4-06-2630869', '978-4-06-2144490'])
+
+# get less than 10,000 ISBNs 
+isbns.size        # => 9,999
+client.get(isbns)
+# raise Error if over 10,000 ISBNs
+isbns.size        # => 10,001
+client.get(isbns) # => Param limit exceeded.
 
 # coverage
 client.coverage
 ```
 
-Set `HTTP_SERVER` or `http_server` as Environment Variable if you'd like to access via proxy server.
+You can ccess [HTTPClient](https://github.com/nahi/httpclient)([doc](http://www.rubydoc.info/gems/httpclient/HTTPClient)). For example:
+
+```rb
+client.httpclient.class # => HTTPClient
+# set debug output device
+client.httplicent.debug_dev = STDOUT
+# set timeout param
+client.connect_timeout = 100
+client.send_timeout    = 100
+client.receive_timeout = 100
+```
+
+## Using proxy
+
+To access resources through HTTP proxy, following methods are available
+
+1. Set Environment Variable
+1. Set `HTTPClient#proxy=(proxy)`
+
+### Set Environment Variable
+
+Set `HTTP_SERVER` or `http_server` as Environment Variable.
 
 ```
 export HTTP_PROXY=http://user:pass@host:port
 # or
-export http_proxy=http://user:pass@host:port
+#export http_proxy=http://user:pass@host:port
+```
+
+### Set `HTTPClient#proxy=(proxy)`
+
+`#httpclient` returns [HTTPClient](http://www.rubydoc.info/gems/httpclient/HTTPClient) instance. 
+
+```rb
+require 'openbd'
+
+client = Openbd::Client.new
+client.httpclient.class # => HTTPClient
+client.httpclient.proxy = 'http://user:pass@host:port'
 ```
 
 ## Requirements
 
-- Ruby(MRI) 2.3.0 or higher
+- Ruby(MRI) 2.2.0 or higher
 
 ## License
 

data/lib/openbd.rb

@@ -1,58 +1,2 @@
 require 'openbd/version'
-require 'httpclient'
-require 'json'
-
-module Openbd
-
-  class RequestError < StandardError; end
-
-  END_POINT = 'https://api.openbd.jp/v1'
-
-  class Client
-
-    def get(isbn)
-      _get(isbn, :get)
-    end
-
-    def get_big(isbn)
-      _get(isbn, :post)
-    end
-
-    def coverage
-      url = "#{END_POINT}/coverage"
-      resp = client.get(url)
-      body(resp)
-    end
-
-    private
-
-    def client
-      @client ||= HTTPClient.new
-    end
-
-    def body(resp)
-      JSON.parse(resp.body)
-    end
-
-    def _get(isbn, method)
-      return unless [:get, :post].include?(method)
-
-      url = "#{END_POINT}/get"
-      q = { isbn: isbn_param(isbn) }
-      resp = client.send(method, url, q)
-      body(resp)
-    end
-
-    def isbn_param(value)
-      isbns = if value.instance_of?(String)
-                value.split(',')
-              elsif value.instance_of?(Array)
-                value
-              else
-                raise Openbd::RequestError,
-                      "Invalid type of param: #{value.class}(#{value})"
-              end
-      isbns.join(',')
-    end
-  end
-end
+require 'openbd/client'

data/lib/openbd/client.rb

@@ -0,0 +1,86 @@
+require 'httpclient'
+require 'json'
+
+module Openbd
+
+  # Raised for request error.
+  class RequestError < StandardError; end
+
+  END_POINT = 'https://api.openbd.jp/v1'
+
+  # The Client class provides a wrapper to the openBD service
+  #
+  # @see https://openbd.jp/
+  # @example
+  #   require 'openbd'
+  #
+  #   client = Openbd::Client.new
+  #
+  #   # get
+  #   client.get('978-4-7808-0204-7')
+  class Client
+
+    # call /get
+    #
+    # @param [String|Array] isbn ISBN
+    # @raise [RequestError] if the request is wrong
+    # @return [Hash] Biblio infomation
+    def get(isbn)
+      url = "#{END_POINT}/get"
+      isbns = isbn_param(isbn)
+      method = get_method(isbns)
+      q = { isbn: isbns.join(',') }
+      resp = httpclient.send(method, url, q)
+      body(resp)
+    end
+
+    # call /coverage
+    #
+    # @return [Array<String>] List of ISBN
+    def coverage
+      url = "#{END_POINT}/coverage"
+      resp = httpclient.get(url)
+      body(resp)
+    end
+
+    # call /schema
+    #
+    def schema
+      url ="#{END_POINT}/schema"
+      resp = httpclient.get(url)
+      body(resp)
+    end
+
+    # get HTTPClient
+    #
+    # @return [HTTPClient] HTTPClient
+    def httpclient
+      @httpclient ||= HTTPClient.new
+    end
+
+    private
+
+    def body(resp)
+      JSON.parse(resp.body)
+    end
+
+    def get_method(isbn_num)
+      if isbn_num.size > 10_000
+        raise Openbd::RequestError, 'Param limit exceeded.'
+      end
+
+      isbn_num.size > 1_000 ? :post : :get
+    end
+
+    def isbn_param(value)
+      if value.instance_of?(String)
+        value.split(',')
+      elsif value.instance_of?(Array)
+        value
+      else
+        raise Openbd::RequestError,
+              "Invalid type of param: #{value.class}(#{value})"
+      end
+    end
+  end
+end

data/lib/openbd/version.rb

@@ -1,3 +1,3 @@
 module Openbd
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/openbd.gemspec

@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 2.3.0'
+  spec.add_development_dependency 'sinatra'
   spec.add_runtime_dependency 'httpclient', '~> 2.8.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openbd
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - kyoshidajp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: httpclient
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +110,7 @@ files:
 - README.md
 - Rakefile
 - lib/openbd.rb
+- lib/openbd/client.rb
 - lib/openbd/version.rb
 - openbd.gemspec
 homepage: http://github.com/kyoshidajp/openbd