companies-house-gateway 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9468ef053dc2a11fdc6aeedc3bd388860a601c04
-  data.tar.gz: 6c8a2bcc628048b75f7a77421c00bcdd683ed056
+  metadata.gz: 730c887e04b54fc8bb3e60f7540e68eae00d59a9
+  data.tar.gz: b5f7058d26397da50d1afb2ae9be1eda41e916b8
 SHA512:
-  metadata.gz: b5530cd08982bca3a4196d3f1021ca76404701e67a02a9e9a4db2c83fd2edfed3225e516b04b7a39810a47ac00489d3d62a139a0981b7b34636ecdea562cad4d
-  data.tar.gz: 769936150be0ed783ca238c210e163d3375ff73b4c789c206ab4681a7f2e7d034f8f80f258d7cb60777d3c1a4f500f065575f474a67b19a9b31508a1a6e2f022
+  metadata.gz: 6b0d5806eb08164da30a9fc469429ee2807ad4fb9e7f98eee4da224a2d0d2acd8c57deeb2270bf84588b15bdd42d3ef047a188e83abedc4ad172737f2fdea9a9
+  data.tar.gz: 11dc3b0517c6d66b87654fd3136ee3a1c6bacb5391eb6e5bfc9c670ab00e9ddb8599232ddcd0317d244effdd10db905ad7d1d329df5b11b51d0b20dc1fe6cd8a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.5 - February 26, 2014
+
+- Allow requests to be cached
+
 ## 0.3.4 - February 26, 2014
 
 - Fix XML generation for CompanyAppointments requests

data/README.md

@@ -54,4 +54,13 @@ Set the "raw" argument to true if you need the full, unprocessed response
 ```ruby
 CompaniesHouseGateway.config[:raw] = true
 CompaniesHouseGateway.name_search(...)         # => Faraday::Response object
+```
+
+### Caching
+
+If you'd like to cache your requests, you can configure the gem:
+
+```ruby
+CompaniesHouseGateway.config[:cache] = Rails.cache
+CompaniesHouseGateway.config[:cache_args] = { expires_in: 10.minutes }
 ```

data/lib/companies_house_gateway/client.rb

@@ -5,8 +5,10 @@ module CompaniesHouseGateway
     end
 
     def perform_check(*args)
-      request = Request.new(connection, @config)
-      request.perform(*args)
+      with_caching(args) do
+        request = Request.new(connection, @config)
+        request.perform(*args)
+      end
     end
 
     def config
@@ -42,5 +44,12 @@ module CompaniesHouseGateway
         c.adapter @config[:adapter]
       end
     end
+
+    # Use cache if configured
+    def with_caching(args, &block)
+      cache_args = config[:cache_args] || {}
+      cache = config[:cache]
+      cache ? cache.fetch(args, cache_args, &block) : yield
+    end
   end
 end

data/lib/companies_house_gateway/config.rb

@@ -5,6 +5,8 @@ module CompaniesHouseGateway
       sender_id:        nil,
       password:         nil,
       email:            nil,
+      cache:            nil,
+      cache_args:       nil,
       raw:              false,
       api_endpoint:     "http://xmlgw.companieshouse.gov.uk/v1-0/xmlgw/Gateway",
       user_agent:       "CompaniesHouseGateway Ruby Gem #{CompaniesHouseGateway::VERSION}".freeze

data/lib/companies_house_gateway/constants.rb

@@ -18,5 +18,15 @@ module CompaniesHouseGateway
       "CUR",       # Current (i.e., not above)
       "EUR",       # SE and ES appointments only
     ].freeze
+
+    # White list of allowed prefixes for companies house numbers.
+    # 1st line is English and Welsh prefixes
+    # 2nd line is Scottish prefixes
+    # 3rd line is Northen Irish prefixes
+    # \d\d is the default prefix in regex notation.
+    ALLOWED_PREFIXES = %w(AC BR FC GE IP LP OC RC SE ZC
+                          SC SA SF SL SZ SP SO SR
+                          NI NA NF NL NZ NP NO NR
+                          \d\d)
   end
 end

data/lib/companies_house_gateway/validations.rb

@@ -3,8 +3,8 @@ module CompaniesHouseGateway
 
     VALIDATIONS = {
       company_name:           ->(value) { clean_string(value, :company_name) },
-      company_number:         ->(value) { value }, # TODO!
-      partial_company_number: ->(value) { value }, # TODO!
+      company_number:         ->(value) { clean_company_number(value) },
+      partial_company_number: ->(value) { value },
       give_mort_totals:       ->(value) { clean_boolean(value, :give_mort_totals) },
       search_rows:            ->(value) { clean_number(value, :search_rows) },
       data_set:               ->(value) { clean_data_set(value) },
@@ -66,6 +66,25 @@ module CompaniesHouseGateway
       type
     end
 
+    def self.clean_company_number(number)
+      return unless number
+      number = number.to_s.strip # remove whitespace
+
+      # 0-pad 5 or 7 digit registration number
+      if number.match /\A(\D{2})(\d{5})\z/
+        number = $1 + $2.rjust(6,"0")
+      elsif number.match /\A\d{7}\z/
+        number = number.rjust(8, "0")
+      end
+
+      companies_house_regex = /\A(#{Constants::ALLOWED_PREFIXES * '|'})\d{6}\z/
+      if number =~ companies_house_regex
+        number
+      else
+        input_error(:company_number, number)
+      end
+    end
+
     def self.input_error(param, value=nil)
       msg = if value.nil?
         "#{param} is a required param"

data/lib/companies_house_gateway/version.rb

@@ -1,3 +1,3 @@
 module CompaniesHouseGateway
-  VERSION = '0.3.4'.freeze
+  VERSION = '0.3.5'.freeze
 end

data/spec/client_spec.rb

@@ -43,6 +43,16 @@ describe CompaniesHouseGateway::Client do
         to receive(:perform).once
       client.perform_check({})
     end
+
+    context "if caching is enabled" do
+      let(:cached_response) { double("Cached response") }
+      let(:cache_stub) { double("Cache", fetch: cached_response) }
+      before { config[:cache] = cache_stub }
+
+      it "caches the request (if enabled)" do
+        client.perform_check({}) == cached_response
+      end
+    end
   end
 
   it_behaves_like "it delegates to the check", :name_search

data/spec/validations_spec.rb

@@ -154,4 +154,70 @@ describe CompaniesHouseGateway::Validations do
       end
     end
   end
+
+  describe '#clean_company_number' do
+    subject do
+      CompaniesHouseGateway::Validations.clean_company_number(number)
+    end
+
+    context "with a number that's too short" do
+      let(:number) { "123456" }
+      it "throws an exception" do
+        expect { subject }.
+          to raise_error CompaniesHouseGateway::InvalidRequestError
+      end
+    end
+
+    context "with a number that's too long" do
+      let(:number) { "123456789" }
+      it "throws an exception" do
+        expect { subject }.
+          to raise_error CompaniesHouseGateway::InvalidRequestError
+      end
+    end
+
+    context "with a number that contains spaces" do
+      let(:number) { "1234 ABC" }
+      it "throws an exception" do
+        expect { subject }.
+          to raise_error CompaniesHouseGateway::InvalidRequestError
+      end
+    end
+
+    context "with a number that contains non alphanumeric chars" do
+      let(:number) { "1234?456" }
+      it "throws an exception" do
+        expect { subject }.
+          to raise_error CompaniesHouseGateway::InvalidRequestError
+      end
+    end
+
+    CompaniesHouseGateway::Constants::ALLOWED_PREFIXES.each do |prefix|
+      context "allows a company number starting with #{prefix}" do
+        prefix = (prefix == '\d\d') ? '07' : prefix
+        let(:number) { "#{prefix}112233" }
+        it { should == "#{prefix}112233" }
+      end
+    end
+
+    context "does not 0-pads 8 digit registration numbers" do
+      let(:number) { "17495895" }
+      it { should == "17495895" }
+    end
+
+    context "0-pads 7 digit registration numbers" do
+      let(:number) { "7495895" }
+      it { should == "07495895" }
+    end
+
+    context "0-pads 5 digit NI registration numbers" do
+      let(:number) { "NI27768" }
+      it { should == "NI027768" }
+    end
+
+    context "does not 0-pads 6 digit NI registration numbers" do
+      let(:number) { "NI127768" }
+      it { should == "NI127768" }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: companies-house-gateway
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Grey Baker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday