epo-ops 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 598720d94ba023a3a3e6b0e2b3f4b018a7f1983e
-  data.tar.gz: d6861675f8ef8abd67a13664c881406a9a8e711a
+  metadata.gz: 61d513627347b49b4799e4fdf0081ff1f34cd712
+  data.tar.gz: 9dbef686b5c975cbc3b36b40bf741fd943db62a8
 SHA512:
-  metadata.gz: 31e1b55be1850539337a550d831d1b63881b4248e8456dcbc1c6a4af1b32e6e289d92a76833434038f53dc97612bf214a1680388f955d7220bee2046e423b25c
-  data.tar.gz: 50f29328406d721d8515cc0436cad653d1cf2e0fdf6f725f372b950c12401968ddaed942b1d57483ab594778b04c26533d5c3f5a8c47ba7606bd6e7240339dfb
+  metadata.gz: da76bac459cb2c43c4c0b018fc5fb5863a33b827de6f07f5ed6716276e6494a5a4b9e8f621fed4bfcefe066590c0b653cf734afe256059dedec87b6ed0ce8f27
+  data.tar.gz: 70a3f9a80c879c004a30e61344264482b2f004de679b62c84e9457fb9acf6c484ec2d3bdc8803a70555fc4b4f9704f65d6be29c2107895994dd9b9ae0b3c6e69

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - "2.0"
-  - "2.1"
-  - "2.2"
-  - "2.3.0"
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1

data/README.md

@@ -24,10 +24,13 @@ require 'epo_ops'
 
 patent_application = EpoOps::PatentApplication.find("EP14731659")
 patent_application.title  # "DEVICE AND METHOD FOR INTRODUCING FIBRES INTO AN EXTRUDER"
-patent_application.classifications # ["B29C47/10", "B29C47/68", "B29C47/92", "B29C45/00", "B01D46/24"] 
+patent_application.classifications # ["B29C47/10", "B29C47/68", "B29C47/92", "B29C45/00", "B01D46/24"]
 patent_application.applicants.first.name # "Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V."
 ```
 
+## Supported Ruby Versions
+For supported versions see _.travis.yml_. We try to keep it updated to officially supported Ruby versions.
+
 ## Advanced Usage
 
 ### OAuth
@@ -60,9 +63,9 @@ CQL search query
 For example to find all applications in IPC Class _A01_ (and all subclasses) that were updated on 2016-01-01
 
 ```ruby
-query = EpoOps::SearchQueryBuilder.build("A01", Date.parse("2016-01-02"))
+query = EpoOps::SearchQueryBuilder.build("A01", Date.parse("2016-01-06"))
 applications = EpoOps::PatentApplication.search(query)
-puts applications.count # 1234
+applications.count #=> 66
 applications.map {|application| puts application.application_nr } # print all application numbers
 applications.map {|application| application.fetch} # fetch complete bibliographic data for each document
 
@@ -89,8 +92,8 @@ EpoOps::Register.search(nil, Date.new(2016,2 ,3))
 You can now retrieve the bibliographic entries of all these:
 
 ```ruby
-references = EpoOps::Register.search(nil, Date.new(2016,2 ,3))
-references.map { |ref| EpoOps::Register.biblio(ref) }
+patent_applications = EpoOps::Register.search(nil, Date.new(2016,2 ,3))
+patent_applications.count == patent_applications.patents.count #=> true
 ```
 
 **Note: Both operations take a considerable amount of time. Also you may not
@@ -108,4 +111,4 @@ of the different endpoints and how to use them (see the 'Downloads' section).
 
 This gem is still an early version and it is far from covering the whole API.
 If you are interested to include different API endpoints than the register it should be easy to include those and we
-are happy to accept pull requests.
+are happy to accept pull requests.

data/epo-ops.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.5'
+  spec.add_development_dependency 'rake', '~> 11'
   spec.add_development_dependency 'minitest', '~> 5.8'
   spec.add_development_dependency 'mocha'
   spec.add_development_dependency 'vcr', '~> 2.9'

data/lib/epo_ops.rb

@@ -1,13 +1,28 @@
+require 'oauth2'
+require 'httparty'
+require 'redis'
+require 'connection_pool'
 require 'epo_ops/version'
 require 'epo_ops/token_store'
 require 'epo_ops/register'
 require 'epo_ops/search_query_builder'
 require 'epo_ops/ipc_class_hierarchy_loader'
 require 'epo_ops/ipc_class_util'
+require 'epo_ops/ipc_class_hierarchy'
 require 'epo_ops/patent_application'
 require 'epo_ops/name_and_address'
 require 'epo_ops/factories'
 require 'epo_ops/register_search_result'
+require 'epo_ops/client'
+require 'epo_ops/util'
+require 'epo_ops/logger'
+require 'epo_ops/limits'
+require 'epo_ops/error'
+require 'epo_ops/rate_limit'
+require 'epo_ops/factories/patent_application_factory'
+require 'epo_ops/factories/name_and_address_factory'
+require 'epo_ops/factories/register_search_result_factory'
+
 
 module EpoOps
   # Configure authentication method and credentials

data/lib/epo_ops/client.rb

@@ -1,6 +1,3 @@
-require 'epo_ops/token_store'
-require 'epo_ops/error'
-
 module EpoOps
 
   # This is a wrapper for OAuth
@@ -13,6 +10,7 @@ module EpoOps
     # @option options [Hash] :headers http request headers
     # @raise [EpoOps::Error] API Error if request was not successful
     def self.request(verb, url, options = {})
+      EpoOps::Logger.debug("Sending Request: #{verb} #{url}")
       response = case EpoOps.config.authentication
                   when :oauth then do_oauth_request(verb, url, options)
                   when :plain then do_plain_request(verb,url,options)
@@ -31,7 +29,7 @@ module EpoOps
     # @return [OAuth2::Response]
     def self.do_oauth_request(verb, url, options = {})
       token = EpoOps.config.token_store.token
-      token.request(verb, URI.encode(url), options)
+      token.request(verb, url, options)
     end
 
     # Make an anonymous request to the EPO API

data/lib/epo_ops/error.rb

@@ -1,5 +1,3 @@
-require 'epo_ops/rate_limit'
-
 module EpoOps
   class Error < StandardError
     # @return [Integer]

data/lib/epo_ops/factories.rb

@@ -1,7 +1,3 @@
-require 'epo_ops/factories/patent_application_factory'
-require 'epo_ops/factories/name_and_address_factory'
-require 'epo_ops/factories/register_search_result_factory'
-
 module EpoOps
   module Factories
 

data/lib/epo_ops/factories/name_and_address_factory.rb

@@ -32,12 +32,9 @@ module EpoOps
                   :country_code,
                   :cdsid
 
-
       def initialize(raw_data)
         @raw_data = raw_data
-
-        @name         = raw_data['name']
-
+        @name = raw_data['name']
         if raw_data['address'].is_a? Hash
           @address_1    = raw_data['address']['address_1']
           @address_2    = raw_data['address']['address_2']
@@ -46,8 +43,7 @@ module EpoOps
           @address_5    = raw_data['address']['address_5']
           @country_code = raw_data['address']['country']
         end
-
-        @cdsid        = raw_data['cdsid']
+        @cdsid = raw_data['cdsid']
       end
     end
   end

data/lib/epo_ops/factories/patent_application_factory.rb

@@ -107,10 +107,9 @@ module EpoOps
       end
 
       private
-        def data_path(*path)
-          %w(bibliographic_data) + path
-        end
-
+      def data_path(*path)
+        %w[bibliographic_data] + path
+      end
     end
   end
 end

data/lib/epo_ops/factories/register_search_result_factory.rb

@@ -34,7 +34,7 @@ module EpoOps
       def patents
         EpoOps::Util.flat_dig(
           @raw_data,
-          %w(world_patent_data register_search register_documents register_document)
+          %w[world_patent_data register_search register_documents register_document]
         ).map {|patent_data| EpoOps::Factories::PatentApplicationFactory.build(patent_data)}
       end
     end

data/lib/epo_ops/ipc_class_hierarchy_loader.rb

@@ -1,6 +1,3 @@
-require 'httparty'
-require 'epo_ops/ipc_class_util'
-
 module EpoOps
   # Usually this should only used internally.
   # Loads the Hierarchy from the WIPO.
@@ -33,7 +30,7 @@ module EpoOps
       # Process every line (There is a line for every class entry, name and description are separated by a \t)
       file.each_line.inject(Hash.new { |h, k| h[k] = [] }) do |mem, line|
         next if line.to_s.strip.empty?
-        ipc_class_generic, description = line.split("\t")
+        ipc_class_generic, _description = line.split("\t")
 
         # Some entries in the files have the same ipc class, the first line is
         # just some kind of headline, the second is the description we want.

data/lib/epo_ops/ipc_class_util.rb

@@ -1,5 +1,3 @@
-require 'epo_ops/ipc_class_hierarchy'
-
 module EpoOps
   # Utility functions to work on Strings representing ipc classes.
   class IpcClassUtil

data/lib/epo_ops/patent_application.rb

@@ -11,11 +11,11 @@ module EpoOps
       # (for example EP and WO) we pick the first one returned - thus the returned document may have a different number
       # @param application_number [String] identifies the application document at EPO
       # @return [PatentApplication] the application document, nil if it can't be found
-      # @note API url: /3.1/rest-services/register/application/epodoc/#{application_number}/biblio
+      # @note API url: /3.2/rest-services/register/application/epodoc/#{application_number}/biblio
       def find(application_number)
         raw_data = EpoOps::Client.request(
           :get,
-          "/3.1/rest-services/register/application/epodoc/#{application_number}/biblio"
+          "/#{EpoOps::API_VERSION}/rest-services/register/application/epodoc/#{application_number}/biblio"
         ).parsed
 
         data = EpoOps::Util.flat_dig(
@@ -41,7 +41,7 @@ module EpoOps
       def search(cql_query)
         data = Client.request(
           :get,
-          '/3.1/rest-services/register/search?' + cql_query
+          "/#{EpoOps::API_VERSION}/rest-services/register/search?" + cql_query
         ).parsed
 
         EpoOps::Factories::RegisterSearchResultFactory.build(data)
@@ -117,6 +117,12 @@ module EpoOps
       @title[lang]
     end
 
+    # Return the applications title in all available languages
+    # @return [Hash] titles in all languagles
+    def titles
+      @title
+    end
+
     # Many fields of the XML the EPO provides have a field
     # `change_gazette_num`.  It is a commercial date (year + week)
     # that describes in which week the element has been
@@ -131,7 +137,7 @@ module EpoOps
 
     # @return [String] The URL at which you can query the original document.
     def url
-      @url ||= "https://ops.epo.org/3.1/rest-services/register/application/epodoc/#{application_nr}"
+      @url ||= "https://ops.epo.org/#{EpoOps::API_VERSION}/rest-services/register/application/epodoc/#{application_nr}"
     end
 
     # Fetches the same document from the register populating all available fields

data/lib/epo_ops/register.rb

@@ -1,11 +1,5 @@
-require 'epo_ops'
-require 'epo_ops/client'
-require 'epo_ops/util'
-require 'epo_ops/logger'
-require 'epo_ops/ipc_class_util'
-
 module EpoOps
-  # Access to the {http://ops.epo.org/3.1/rest-services/register register}
+  # Access to the {http://ops.epo.org/#{EpoOps::API_VERSION}/rest-services/register register}
   # endpoint of the EPO OPS API.
   #
   # By now you can search and retrieve patents by using the type `application`
@@ -89,7 +83,7 @@ module EpoOps
     def self.raw_search(query, raw = false)
       data = Client.request(
         :get,
-        '/3.1/rest-services/register/search?' + query
+        "/#{EpoOps::API_VERSION}/rest-services/register/search?" + query
       ).parsed
 
       EpoOps::Factories::RegisterSearchResultFactory.build(data)

data/lib/epo_ops/search_query_builder.rb

@@ -1,6 +1,3 @@
-require 'epo_ops/limits'
-require 'epo_ops/logger'
-
 module EpoOps
   # This Builder helps creating a search query using
   # {https://www.loc.gov/standards/sru/cql/ CQL} (Common Query Language or

data/lib/epo_ops/token_store.rb

@@ -1,13 +1,10 @@
-require 'oauth2'
-require 'epo_ops'
-
 module EpoOps
   # This class saves the token in memory, you may want to subclass this and
   # overwrite #token if you want to store it somewhere else.
   #
   class TokenStore
     def token
-      @token = generate_token if !@token || @token.expired?
+      @token = generate_token if @token.nil? || @token.expired?
 
       @token
     end
@@ -23,7 +20,7 @@ module EpoOps
         EpoOps.config.consumer_key,
         EpoOps.config.consumer_secret,
         site: 'https://ops.epo.org/',
-        token_url: '/3.1/auth/accesstoken',
+        token_url: "/#{EpoOps::API_VERSION}/auth/accesstoken",
         raise_errors: false
       )
 

data/lib/epo_ops/token_store/redis.rb

@@ -1,6 +1,3 @@
-require 'redis'
-require 'connection_pool'
-
 module EpoOps
   class TokenStore
     class Redis < TokenStore

data/lib/epo_ops/util.rb

@@ -46,7 +46,7 @@ module EpoOps
     def self.parse_change_gazette_num(num)
       res = /^(?<year>\d{4})\/(?<week>\d{2})$/.match(num)
       return nil if res.nil?
-      Date.commercial(Integer(res[:year], 10), week = Integer(res[:week], 10))
+      Date.commercial(Integer(res[:year], 10), Integer(res[:week], 10))
     end
   end
 end

data/lib/epo_ops/version.rb

@@ -1,3 +1,4 @@
 module EpoOps
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.1'.freeze
+  API_VERSION = '3.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epo-ops
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Max Kießling
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2017-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby interface to the European Patent Office API (OPS)