patentscope 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5aa36ae41718e4f20b1a200b6ab43ed4cfb5e432
-  data.tar.gz: bccacf5fa59cd36ab13ee33ed25ceca494979f5e
+SHA256:
+  metadata.gz: 56467a752fa6f75a07f027d64ed5a72b74b9f2bdf82788e663912db497ed5d04
+  data.tar.gz: b1ded97d783ff2bcb84ce8bf57579e435ef9491b0000f094da5f53351cd2523e
 SHA512:
-  metadata.gz: 693b96c16e555e1f3e44d28d234b46e2bda865537b73901716578454cf5477f2394e394f50f5ea9fb7a5139d71af51f0b14d4d8e8ae1ddf02605eaae28a63112
-  data.tar.gz: 39b580c2b24c3a60ae20e18f1d2c7e356053c12180424331f5ae58d2db61e5472af372608b03d4cc6e3b2adb77826b28c46b1b4646e025f36848e7faa10b55e1
+  metadata.gz: e1aab43b44f90067aa5fbfd1a69e9d8cb65388dbfaacacbe27472b87b38c68f6beed3c9765865fc7d4717bb0a4acf44c1c548c517f56e7f650c615ac3693bec0
+  data.tar.gz: 0f08bdc948ac997d4820d6d0a730b1fd8f96c058b093303d7aa41e45ab783fa3febfc64a0c3d4e78656d7a269039970e9ef4a0594e6c066ef9b4b6fc842fea34

data/.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "4.0.5"
+          bundler-cache: true
+      - run: bundle exec rake spec:core

data/.ruby-version

@@ -1 +1 @@
-2.4.2
+4.0.5

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-ruby '2.4.2'
+ruby '4.0.5'
 
 # Specify your gem's dependencies in patentscope.gemspec
 gemspec

data/README.md

@@ -182,9 +182,10 @@ The `wsdl` method returns a WSDL document for the PATENTSCOPE Web Service
 
 * NoCredentialsError - attempting to use the client when no credentials were entered
 * WrongCredentialsError - attempting to access the PATENTSCOPE Webservice with incorrect credentials
-* NoAppNumberError - no application numbere was entered, or unable to convert number
+* NoAppNumberError - no application number was entered
 * NoDocIDError - no document id was entered
 * NoPageIDError - no page id was entered
+* WrongNumberFormatError - unable to convert an application or publication number
 * BusinessError - PATENTSCOPE Webservice returned a "business error"
 
 ## Disclaimer
@@ -222,6 +223,21 @@ For support on the PATENTSCOPE Web Service, please see the resources in the sect
 * [Webinars](http://www.wipo.int/patentscope/en/webinar/)
 * [Forum](http://wipo-patentscope-forum.2944828.n2.nabble.com)
 
+## Testing
+
+Run the credential-free core suite with:
+
+    $ bundle exec rake spec:core
+
+The default `rake`, `rake test`, and `rspec spec` commands also run the core
+suite. Live PATENTSCOPE Web Service examples require valid credentials and can
+be run separately with:
+
+    $ bundle exec rake spec:more
+
+If the PATENTSCOPE credential environment variables are not set, the live
+examples are skipped.
+
 ## Contact
 Comments and bug reports are welcome.
 

data/Rakefile

@@ -12,7 +12,7 @@ namespace :spec do
 
   RSpec::Core::RakeTask.new(:core) do |task|
     task.pattern = "./spec/**/*_spec.rb"
-    task.rspec_opts = '--tag core'
+    task.rspec_opts = '--tag core --tag ~more'
   end
 
   desc 'Run additional RSpec examples (e.g., integration specs)'
@@ -32,5 +32,5 @@ task console: :dotenv do
   IRB.start
 end
 
-task default: :spec
-task test:    :spec
+task default: 'spec:core'
+task test:    'spec:core'

data/lib/patentscope/client.rb

@@ -1,5 +1,6 @@
 require 'net/http'
-require 'nokogiri'
+require 'open-uri'
+require 'uri'
 
 module Patentscope
 
@@ -7,6 +8,8 @@ module Patentscope
     attr_reader :username, :password
 
     USER_AGENT_STRING = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_4) AppleWebKit/536.30.1 (KHTML, like Gecko) Version/6.0.5 Safari/536.30.1"
+    OPEN_TIMEOUT = 10
+    READ_TIMEOUT = 60
 
     def initialize(args = {})
       @username = args[:username]
@@ -14,7 +17,7 @@ module Patentscope
     end
 
     def get_url(url)
-      open(url, "User-Agent" => USER_AGENT_STRING, http_basic_authentication: [username, password]).read
+      URI.open(url, "User-Agent" => USER_AGENT_STRING, http_basic_authentication: [username, password]).read
     end
 
     def post_url(url, content_type = 'text/html', body = '')
@@ -25,16 +28,31 @@ module Patentscope
       request["Content-Type"] = content_type
       request.body            = body
 
-      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        response      = http.request(request)
-        response.body = response.body.force_encoding("ISO-8859-1").encode("UTF-8")
+      Net::HTTP.start(uri.host, uri.port,
+                      use_ssl: uri.scheme == 'https',
+                      open_timeout: OPEN_TIMEOUT,
+                      read_timeout: READ_TIMEOUT) do |http|
+        response = http.request(request)
+        raise WrongCredentialsError if response.is_a?(Net::HTTPUnauthorized)
 
-        if response.header["Content-Type"].include? "text/html"
-          response.body
-        elsif response.header["Content-Type"].include? "multipart/related"
-          response.body.split("\r\n\r\n")[1].split("\r\n")[0]
+        body = response.body.to_s.force_encoding("ISO-8859-1").encode("UTF-8")
+        content_type = response.header["Content-Type"].to_s
+
+        if content_type.include?("multipart/related")
+          multipart_xml_body(body)
+        else
+          body
         end
       end
     end
+
+    private
+
+    def multipart_xml_body(body)
+      parts = body.split("\r\n\r\n", 2)
+      return body unless parts.length == 2
+
+      parts.last.split("\r\n").first.to_s
+    end
   end
 end

data/lib/patentscope/configuration.rb

@@ -20,12 +20,20 @@ module Patentscope
     end
 
     def configured?
-      (configuration && configuration.username && configuration.password)? true : false
+      !!(configuration &&
+         present?(configuration.username) &&
+         present?(configuration.password))
     end
 
     def reset_configuration
       self.configuration = nil
     end
+
+    private
+
+    def present?(value)
+      !value.to_s.strip.empty?
+    end
   end
 
   class Configuration

data/lib/patentscope/pct_doc_number.rb

@@ -3,7 +3,7 @@ module Patentscope
   class PctAppNumber < String
 
     def initialize(number = "")
-      raise NoNumberError,
+      raise NoAppNumberError,
         "Patent application number was not entered" if number.nil?
       super(number.strip)
     end
@@ -15,20 +15,19 @@ module Patentscope
     def validate
       raise WrongNumberFormatError,
         "PCT application number is not in correct format (PCT/CCYYYY/NNNNNN)" unless valid?
+      true
     end
 
     def to_ia_number
-      self.upcase!
-      self.gsub!('/', '')
-      self.gsub!('PCT', '')
-      self
+      validate
+      upcase.gsub('/', '').sub(/\APCT/, '')
     end
   end
 
   class PctPubNumber < String
 
     def initialize(number = "")
-      raise NoNumberError,
+      raise NoAppNumberError,
         "Patent publication number was not entered" if number.nil?
       super(number.strip)
     end
@@ -40,6 +39,7 @@ module Patentscope
     def validate
       raise WrongNumberFormatError,
         "PCT publication number is not in correct format (WO/YYYY/NNNNNN)" unless valid?
+      true
     end
   end
 end

data/lib/patentscope/version.rb

@@ -1,5 +1,5 @@
 module Patentscope
 
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 
 end

data/lib/patentscope/webservice.rb

@@ -9,33 +9,33 @@ module Patentscope
     end
 
     def get_available_documents(args = {})
-      ia_number = PctAppNumber.new(args[:ia_number]).to_ia_number
+      ia_number = normalized_ia_number(args[:ia_number])
       perform_operation(:getAvailableDocuments, { iaNumber: ia_number })
     end
 
     def get_document_content(args = {})
-      doc_id = args[:doc_id]
+      doc_id = required_value(args[:doc_id], NoDocIDError, "Document id was not entered")
       perform_operation(:getDocumentContent, { docId: doc_id })
     end
 
     def get_document_ocr_content(args = {})
-      doc_id = args[:doc_id]
+      doc_id = required_value(args[:doc_id], NoDocIDError, "Document id was not entered")
       perform_operation(:getDocumentOcrContent, { docId: doc_id })
     end
 
     def get_iasr(args = {})
-      ia_number = PctAppNumber.new(args[:ia_number]).to_ia_number
+      ia_number = normalized_ia_number(args[:ia_number])
       perform_operation(:getIASR, { iaNumber: ia_number })
     end
 
     def get_document_table_of_contents(args = {})
-      doc_id = args[:doc_id]
+      doc_id = required_value(args[:doc_id], NoDocIDError, "Document id was not entered")
       perform_operation(:getDocumentTableOfContents, { docId: doc_id })
     end
 
     def get_document_content_page(args = {})
-      doc_id  = args[:doc_id]
-      page_id = args[:page_id]
+      doc_id  = required_value(args[:doc_id], NoDocIDError, "Document id was not entered")
+      page_id = required_value(args[:page_id], NoPageIDError, "Page id was not entered")
       perform_operation(:getDocumentContentPage, { docId: doc_id, pageId: page_id })
     end
 
@@ -43,7 +43,7 @@ module Patentscope
 
     def perform_operation(operation, options_hash)
       soap_envelope = soapbuilder.build_envelope(operation, options_hash)
-      response = send_soap_request(soap_envelope)
+      response = send_soap_request(soap_envelope).to_s
       if response.include?('Error') && response.include?('Unauthorized')
         raise WrongCredentialsError
       elsif response.include?('Business error during the execution of service')
@@ -61,6 +61,16 @@ module Patentscope
       client.get_url(PATENTSCOPE_WEBSERVICE_LOCATION + '?wsdl')
     end
 
+    def normalized_ia_number(number)
+      PctAppNumber.new(number).to_ia_number
+    end
+
+    def required_value(value, error_class, message)
+      value = value.to_s.strip
+      raise error_class, message if value.empty?
+      value
+    end
+
     def client
       raise NoCredentialsError unless Patentscope.configured?
       Client.new(username: Patentscope.configuration.username,

data/lib/patentscope/webservice_soap_builder.rb

@@ -1,3 +1,5 @@
+require 'nokogiri'
+
 module Patentscope
 
   class WebserviceSoapBuilder

data/lib/patentscope/webservice_soap_stripper.rb

@@ -1,3 +1,5 @@
+require 'nokogiri'
+
 module Patentscope
 
   class WebserviceSoapStripper

data/lib/patentscope.rb

@@ -12,6 +12,10 @@ module Patentscope
   class WrongCredentialsError < StandardError; end
   class BusinessError < StandardError; end
   class WrongNumberFormatError < StandardError; end
+  class NoAppNumberError < WrongNumberFormatError; end
+  class NoDocIDError < WrongNumberFormatError; end
+  class NoPageIDError < WrongNumberFormatError; end
+  NoNumberError = NoAppNumberError
 
   class << self
 
@@ -50,4 +54,3 @@ module Patentscope
     end
   end
 end
-

data/patentscope.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Ruby interface with WIPO PATENTSCOPE Web Service}
   spec.description   = %q{Ruby interface to the PATENTSCOPE Web Service provided by the World Intellectual Property Organisation. Requires a subscription to the Patentscope Web Service}
   spec.homepage      = "http://www.cantab-ip.com"
+  spec.required_ruby_version = ">= 4.0.5"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -21,12 +22,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'dotenv', '~> 2.2'
-  spec.add_development_dependency 'rake', '~> 12.2'
-  spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 3.1'
+  spec.add_development_dependency 'dotenv', '>= 3.0'
+  spec.add_development_dependency 'rake', '>= 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'vcr', '~> 6.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
 
-  spec.add_runtime_dependency 'nokogiri', '~> 1.8'
-  spec.add_runtime_dependency 'unicode_titlecase', '~> 0'
+  spec.add_runtime_dependency 'nokogiri', '>= 1.15'
 end

metadata

@@ -1,113 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: patentscope
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Chong-Yee Khoo
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.2'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.2'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: unicode_titlecase
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
 description: Ruby interface to the PATENTSCOPE Web Service provided by the World Intellectual
   Property Organisation. Requires a subscription to the Patentscope Web Service
 email:
@@ -116,10 +101,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - License.txt
 - README.md
@@ -137,7 +122,6 @@ homepage: http://www.cantab-ip.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -145,16 +129,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 4.0.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Ruby interface with WIPO PATENTSCOPE Web Service
 test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.1.2