patentscope 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b523ee313b0b12c65cb68e78290344465927835
+  data.tar.gz: ba4a83db30178a6b82c356749732ff8850d96289
+SHA512:
+  metadata.gz: 4671bda95ce98bdb5258b33e65b8a2919e1489b8173d8a8d3cc167d9fab95af416e5de334344b551fa93a4e28df8c97621395998326bf56e60a74dd36c44a759
+  data.tar.gz: b0d0a48b09c52f15b0d75c4763dc67981ce89d3c28049dad29d1accc74cbb840b471e4f10b7749ac282a36ee6963855bea8df96fde4328dd32f30dbf6a8a848b

data/.gitignore

@@ -24,3 +24,6 @@ tmp
 
 # Ignore binstubs generated by bundle install --binstubs
 /bin
+
+# Ignore .env file used by dotenv gem
+.env

data/.ruby-version

@@ -1 +1 @@
-1.9.3-p484
+2.1.2

data/.travis.yml

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

data/README.md

@@ -1,5 +1,8 @@
 # patentscope gem
-Gem to allow easy access to data from the WIPO Patentscope Web Service.
+[![Gem Version](https://badge.fury.io/rb/patentscope.png)](http://badge.fury.io/rb/patentscope)
+[![Code Climate](https://codeclimate.com/github/cantab/patentscope.png)](https://codeclimate.com/github/cantab/patentscope)
+
+Gem to allow easy access to data from the WIPO PATENTSCOPE Web Service.
 
 ## Introduction
 
@@ -103,7 +106,7 @@ The `get_iasr` method takes an International Application number, with or without
 
 Example output for SG2003000062:
 
-		Patentscope.get_iasr('SG2003000062')				
+		Patentscope.get_iasr('SG2003000062')
 		#=>
 		<?xml version="1.0"?>
 		<wo-international-application-status>
@@ -202,6 +205,10 @@ For support on the PATENTSCOPE Web Service, please see the resources in the sect
 
 ## Resources
 
+### Web App Using Patentscope Gem
+
+* The [PCT National Phase](http://guides.cantab-ip.com/singapore-national-phase) Guide fetches IASR data from WIPO PATENTSCOPE and displays a customised guide for the national phase entry of a PCT application
+
 ### PATENTSCOPE Web Service
 * [PATENTSCOPE Web Service](http://www.wipo.int/patentscope/en/data/products.html)
 * [Terms and Conditions](http://www.wipo.int/patentscope/en/data/terms.html)

data/Rakefile

@@ -1,5 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'dotenv/tasks'
 
 desc 'Run RSpec examples (all)'
 
@@ -20,7 +21,15 @@ namespace :spec do
     task.pattern = "./spec/**/*_spec.rb"
     task.rspec_opts = '--tag more'
   end
+end
 
+task console: :dotenv do
+  require 'irb'
+  require 'irb/completion'
+  require 'patentscope'
+  Patentscope.configure_from_env
+  ARGV.clear
+  IRB.start
 end
 
 task default: :spec

data/lib/patentscope/configuration.rb

@@ -20,9 +20,7 @@ module Patentscope
     end
 
     def configured?
-      configuration &&
-      configuration.username &&
-      configuration.password
+      (configuration && configuration.username && configuration.password)? true : false
     end
 
     def reset_configuration
@@ -38,5 +36,4 @@ module Patentscope
       @password = ''
     end
   end
-
 end

data/lib/patentscope/version.rb

@@ -1,5 +1,5 @@
 module Patentscope
 
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 
 end

data/patentscope.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Patentscope::VERSION
   gem.authors       = ["Chong-Yee Khoo"]
   gem.email         = ["mail@cykhoo.com"]
-  gem.description   = %q{Ruby interface to the Patentscope Webservice provided by the World Intellectual Property Organisation. Requires a subscription to the Patentscope Web Service}
-  gem.summary       = %q{Ruby interface with WIPO Patentscope Webservice}
+  gem.description   = %q{Ruby interface to the PATENTSCOPE Web Service provided by the World Intellectual Property Organisation. Requires a subscription to the Patentscope Web Service}
+  gem.summary       = %q{Ruby interface with WIPO PATENTSCOPE Web Service}
   gem.homepage      = "http://www.cantab-ip.com"
 
   gem.files         = `git ls-files`.split($/)
@@ -17,10 +17,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec', '~> 3.0.0.beta1'
-  gem.add_development_dependency 'vcr'
-  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'dotenv', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 10.3'
+  gem.add_development_dependency 'rspec', '~> 3.1'
+  gem.add_development_dependency 'vcr', '~> 2.9.2'
+  gem.add_development_dependency 'webmock', '~> 1.19'
 
   gem.add_runtime_dependency 'nokogiri'
   gem.add_runtime_dependency 'unicode_titlecase'

data/spec/configuration_spec.rb

@@ -2,136 +2,224 @@ require 'spec_helper'
 
 module Patentscope
 
-  describe Patentscope do
+  describe Configuration, :core do
 
-    it 'has a configure class method' do
-      expect(Patentscope).to respond_to(:configure)
-    end
+    describe 'instance methods' do
 
-    it 'has a configure_from_env class method' do
-      expect(Patentscope).to respond_to(:configure_from_env)
-    end
+      it 'has a username instance method' do
+        expect(Configuration.new).to respond_to(:username)
+      end
 
-    it 'has a configured? class method' do
-      expect(Patentscope).to respond_to(:configured?)
+      it 'has a password instance method' do
+        expect(Configuration.new).to respond_to(:password)
+      end
     end
 
-    it 'has a reset_configuration class method' do
-      expect(Patentscope).to respond_to(:reset_configuration)
-    end
+    describe 'initialize' do
 
-    it 'has a configuration class method' do
-      expect(Patentscope).to respond_to(:configuration)
+      let(:configuration) { Configuration.new }
+
+      describe 'default values' do
+
+        it 'username is blank' do
+          expect(configuration.username).to eq('')
+        end
+
+        it 'password is blank' do
+          expect(configuration.password).to eq('')
+        end
+      end
     end
   end
 
-  describe 'Patentscope::Configuration class' do
+  describe Patentscope, :core, :vcr do
 
-    it 'has a username instance method' do
-      expect(Patentscope::Configuration.new).to respond_to(:username)
+    before(:each) do
+      Patentscope.reset_configuration
     end
 
-    it 'has a password instance method' do
-      expect(Patentscope::Configuration.new).to respond_to(:password)
+    after(:each) do
+      Patentscope.reset_configuration
     end
-  end
 
-  describe 'Patentscope before configuration' do
+    describe 'class methods' do
 
-    before { Patentscope.reset_configuration }
+      it 'has configure class method' do
+        expect(Patentscope).to respond_to(:configure)
+      end
 
-    it 'configuration object is nil if configure not called' do
-      expect(Patentscope.configuration).to be_nil
-    end
+      it 'has configure_from_env class method' do
+        expect(Patentscope).to respond_to(:configure_from_env)
+      end
+
+      it 'has configured? class method' do
+        expect(Patentscope).to respond_to(:configured?)
+      end
 
-    it 'is not configured' do
-      expect(Patentscope.configured?).to be_falsey
+      it 'has reset_configuration class method' do
+        expect(Patentscope).to respond_to(:reset_configuration)
+      end
     end
 
-    it 'raises an error during client operations' do
-      expect do
-        Webservice.new.get_iasr(ia_number: 'SG2009000062')
-      end.to raise_error(Patentscope::NoCredentialsError)
+    it 'has an class level accessor to the configuration instance' do
+      expect(Patentscope).to respond_to(:configuration)
     end
-  end
 
-  describe 'Patentscope with configuration but no specific credentials given' do
+    describe 'unconfigured' do
 
-    before { Patentscope.reset_configuration }
+      describe 'configuration state' do
 
-    it 'username defaults to null string if not explicitly set in the configure block' do
-      Patentscope.configure
-      expect(Patentscope.configuration.username).to eq('')
-    end
+        it 'is not configured' do
+          expect(Patentscope.configured?).to be false
+        end
 
-    it 'password defaults to null string if not explicitly set in the configure block' do
-      Patentscope.configure
-      expect(Patentscope.configuration.password).to eq('')
-    end
+        it 'configuration object is nil' do
+          expect(Patentscope.configuration).to be_nil
+        end
+      end
 
-    it 'raises an error during client operations' do
-      expect do
-        Webservice.new.get_iasr(ia_number: 'SG2009000062')
-      end.to raise_error(Patentscope::NoCredentialsError)
-    end
-  end
+      describe 'behaviours when called' do
 
-  describe 'Patentscope with configuration using configuration block' do
+        it 'raises an error when trying to access username' do
+          expect do
+            Patentscope.configuration.username
+          end.to raise_error(NoMethodError)
+        end
+
+        it 'raises an error when trying to access password' do
+          expect do
+            Patentscope.configuration.password
+          end.to raise_error(NoMethodError)
+        end
 
-    before do
-      Patentscope.configure do |config|
-        config.username     = 'joe_bloggs'
-        config.password     = 'b10ggsy'
+        it 'raises an error during client operations' do
+          expect do
+            Webservice.new.get_iasr(ia_number: 'SG2009000062')
+          end.to raise_error(Patentscope::NoCredentialsError)
+        end
       end
     end
 
-    after(:each) do
-      Patentscope.reset_configuration
-    end
+    describe 'Patentscope.configure' do
 
-    it 'configures the username and password in a block in the configure method' do
-      expect(Patentscope.configuration.username).to eq('joe_bloggs')
-      expect(Patentscope.configuration.password).to eq('b10ggsy')
-    end
-  end
+      context 'Patentscope.configure called but no credentials given in block' do
 
-  describe "Patentscope with configuration loading from environment variables" do
+        before { Patentscope.configure }
 
-    after(:each) do
-      Patentscope.reset_configuration
-    end
+        describe 'configuration state' do
+
+          it 'is configured' do
+            expect(Patentscope.configured?).to be true
+          end
 
-    describe 'where a configuration has already been set' do
-      before do
-        Patentscope.configure do |config|
-          config.username     = 'joe_bloggs'
-          config.password     = 'b10ggsy'
+          it 'configuration object exists' do
+            expect(Patentscope.configuration).to_not be_nil
+          end
+
+          it 'username defaults to null string if not explicitly set in the configure block' do
+            expect(Patentscope.configuration.username).to eq('')
+          end
+
+          it 'password defaults to null string if not explicitly set in the configure block' do
+            expect(Patentscope.configuration.password).to eq('')
+          end
         end
-      end
 
-      it 'loading operation fails' do
-        expect(Patentscope.configure_from_env).to be false
+        describe 'behaviours when called' do
+
+          it 'does not raise an error when trying to access username' do
+            expect do
+              Patentscope.configuration.username
+            end.to_not raise_error
+          end
+
+          it 'does not raise an error when trying to access password' do
+            expect do
+              Patentscope.configuration.password
+            end.to_not raise_error
+          end
+
+          it 'raises an error during client operations' do
+            expect do
+              Webservice.new.get_iasr(ia_number: 'SG2009000062')
+            end.to raise_error(Patentscope::WrongCredentialsError)
+          end
+        end
       end
 
-      it 'does not overwrite existing configuration' do
-        expect(Patentscope.configuration.username).to eq('joe_bloggs')
-        expect(Patentscope.configuration.password).to eq('b10ggsy')
+      context 'Patentscope.configure called with credentials set in block' do
+
+        before(:each) do
+          Patentscope.configure do |config|
+            config.username     = 'joe_bloggs'
+            config.password     = 'b10ggsy'
+          end
+        end
+
+        it 'configures the username' do
+          expect(Patentscope.configuration.username).to eq('joe_bloggs')
+        end
 
-        expect(Patentscope.configuration.username).to_not eq(ENV['PATENTSCOPE_WEBSERVICE_USERNAME'])
-        expect(Patentscope.configuration.password).to_not eq(ENV['PATENTSCOPE_WEBSERVICE_PASSWORD'])
+        it 'configures the password' do
+          expect(Patentscope.configuration.password).to eq('b10ggsy')
+        end
       end
     end
 
-    describe 'where there is no existing configuration' do
+    describe 'Patentscope.configure_from_env"'do
+
+      context 'with no existing configuration' do
+
+        it 'loading operation succeeds' do
+          expect(Patentscope.configure_from_env).to be true
+        end
+
+        describe 'loads configurations from environment variables' do
 
-      it 'loading operation succeeds' do
-        expect(Patentscope.configure_from_env).to be true
+          before do
+            ENV['PATENTSCOPE_WEBSERVICE_USERNAME'] = 'joe_bloggs'
+            ENV['PATENTSCOPE_WEBSERVICE_PASSWORD'] = 'b10ggsy'
+            Patentscope.configure_from_env
+          end
+
+          it 'loads the username' do
+            expect(Patentscope.configuration.username).to eq('joe_bloggs')
+          end
+
+          it 'loads the password' do
+            expect(Patentscope.configuration.password).to eq('b10ggsy')
+          end
+        end
       end
 
-      it 'assigns the configuration from environment variables' do
-        Patentscope.configure_from_env
-        expect(Patentscope.configuration.username).to eq(ENV['PATENTSCOPE_WEBSERVICE_USERNAME'])
-        expect(Patentscope.configuration.password).to eq(ENV['PATENTSCOPE_WEBSERVICE_PASSWORD'])
+      context 'with an existing configuration already loaded' do
+
+        before do
+          ENV['PATENTSCOPE_WEBSERVICE_USERNAME'] = 'foo'
+          ENV['PATENTSCOPE_WEBSERVICE_PASSWORD'] = 'bar'
+          Patentscope.configure_from_env
+        end
+
+        it 'loading operation fails' do
+          expect(Patentscope.configure_from_env).to be false
+        end
+
+        describe 'does not load configurations from environment variables' do
+
+          before do
+            ENV['PATENTSCOPE_WEBSERVICE_USERNAME'] = 'joe_bloggs'
+            ENV['PATENTSCOPE_WEBSERVICE_PASSWORD'] = 'b10ggsy'
+            Patentscope.configure_from_env
+          end
+
+          it 'keeps the already configured username' do
+            expect(Patentscope.configuration.username).to eq('foo')
+          end
+
+          it 'keeps the already configured password' do
+            expect(Patentscope.configuration.password).to eq('bar')
+          end
+        end
       end
     end
   end

data/spec/patentscope_spec.rb

@@ -34,7 +34,7 @@ module Patentscope
       it 'returns an appropriate XML document for the get_available_documents operation' do
         response = patentscope.get_available_documents('SG2009000062')
         expect(response).to include('<?xml version="1.0"?>')
-        expect(response).to include('<doc ocrPresence="no" docType="RO101" docId="id00000008679651"/>')
+        expect(response).to include('<doc ocrPresence="yes" gazette="35/2009" docType="PAMPH" docId="id00000008693323"/>')
         expect(response).to_not include('<getAvailableDocumentsResponse xmlns="http://www.wipo.org/wsdl/ps">')
       end
     end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'bundler'
 Bundler.setup(:default, :development)
 
+require 'dotenv'
+Dotenv.load
 require 'patentscope'
 require 'rspec'
 require 'vcr'

data/spec/webservice_spec.rb

@@ -40,7 +40,7 @@ module Patentscope
       it 'returns an appropriate XML document for the get_available_documents operation' do
         response = webservice.get_available_documents(ia_number: 'SG2009000062')
         expect(response).to include('<?xml version="1.0"?>')
-        expect(response).to include('<doc ocrPresence="no" docType="RO101" docId="id00000008679651"/>')
+        expect(response).to include('<doc ocrPresence="yes" gazette="35/2009" docType="PAMPH" docId="id00000008693323"/>')
         expect(response).to_not include('<getAvailableDocumentsResponse xmlns="http://www.wipo.org/wsdl/ps">')
       end
     end

metadata

@@ -1,113 +1,114 @@
 --- !ruby/object:Gem::Specification
 name: patentscope
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Chong-Yee Khoo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-10-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta1
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta1
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.9.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: unicode_titlecase
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby interface to the Patentscope Webservice provided by the World Intellectual
+description: Ruby interface to the PATENTSCOPE Web Service provided by the World Intellectual
   Property Organisation. Requires a subscription to the Patentscope Web Service
 email:
 - mail@cykhoo.com
@@ -115,9 +116,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-version
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - License.txt
 - README.md
@@ -143,34 +145,27 @@ files:
 - spec/wipo_test_suite_spec.rb
 homepage: http://www.cantab-ip.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3671612522132073202
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3671612522132073202
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: Ruby interface with WIPO Patentscope Webservice
+specification_version: 4
+summary: Ruby interface with WIPO PATENTSCOPE Web Service
 test_files:
 - spec/client_spec.rb
 - spec/configuration_spec.rb