courtfinder-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13ada6003ce78ac35d50232679d81dfc90437902
+  data.tar.gz: d0d6b2f1237b1b34e4c6fd6bf548e7b87467b66b
+SHA512:
+  metadata.gz: 5992de9d86d641204284116dc80981308f44db42a7505ac4f5007ddd8a216c3a41b38518fd7712424021ea93639ea87d5722bc024d923f0326e95ed685e435ee
+  data.tar.gz: 496e63fc92b41c5e2733dbfa02b0346192b54684411c424434b961371b79feb779fd4ae7613ea7acec4ed9f69d6cf169f207458473659d90e19f70c2b05a6371

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in courtfinder-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aleksandar Simić
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Courtfinder::Client
+
+Client for UK Government [Court and tribunal finder](https://courttribunalfinder.service.gov.uk/) API
+
+Currently **only** implemented querying courts for **'Housing possesion'**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'courtfinder-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install courtfinder-client
+
+## Usage
+
+Sample usage:
+
+    require 'courtfinder/client'
+
+    client = Courtfinder::Client::HousingPossession.new
+    client.get 'SG8 0LT'
+
+Which will return the address of the court in 'Housing possession'
+area of law for the given postcode.
+
+**TODO:** Add support for courts in other areas of law.
+
+## Contributing
+
+1. Fork it ( https://github.com/ministryofjustice/courtfinder-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/courtfinder-client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'courtfinder/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "courtfinder-client"
+  spec.version       = Courtfinder::Client::VERSION
+  spec.authors       = ["Aleksandar Simić"]
+  spec.email         = ["alex.simic@digital.justice.gov.uk"]
+  spec.summary       = %q{Courtfinder client gem}
+  spec.description   = %q{https://courttribunalfinder.service.gov.uk/ API client}
+  spec.homepage      = "https://github.com/ministryofjustice/courtfinder-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "webmock", "~> 1.18"
+  spec.add_development_dependency "faraday", "~> 0.9"
+end

data/lib/courtfinder/client.rb

@@ -0,0 +1,36 @@
+require 'courtfinder/client/version'
+require 'faraday'
+require 'json'
+require 'uri'
+
+module Courtfinder
+  SERVER = 'http://54.72.152.89'
+  module Client
+    class HousingPossession
+      PATH='/search/results.json?area_of_law=Housing+possession&postcode='
+
+      def get postcode
+        conn = Faraday.get "#{Courtfinder::SERVER}#{PATH}#{URI.escape(postcode)}"
+        process_address conn.body
+      end
+
+      private
+
+      def process_address data
+        if data == '[]'
+          data
+        else
+          json = JSON.parse data
+          address_json = json[0]["address"]
+          name_n_street = "#{address_json["address_lines"].join("\n")}"
+          <<-EOS.chomp.gsub('  ', '')
+            #{name_n_street}
+            #{address_json["town"]}
+            #{address_json["county"]}
+            #{address_json["postcode"]}
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/courtfinder/client/version.rb

@@ -0,0 +1,5 @@
+module Courtfinder
+  module Client
+    VERSION = "0.0.1"
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,49 @@
+require 'webmock/rspec'
+require_relative 'support/helper'
+require 'courtfinder/client'
+
+describe Courtfinder::Client::HousingPossession do
+  before { WebMock.disable_net_connect! }
+
+  describe '.get' do
+    let(:client) { Courtfinder::Client::HousingPossession.new }
+    let(:address) {
+      "Cambridge County Court and Family Court Hearing Centre\n197 East Road\nCambridge\nCambridgeshire\nCB1 1BA"
+    }
+
+    def stub_with postcode
+      stub_request(:get, "#{Courtfinder::SERVER}#{Courtfinder::Client::HousingPossession::PATH}#{postcode}")
+        .to_return(:body => fixture('result.json'),
+                   :headers => {:content_type => 'application/json; charset=utf-8'})
+    end
+
+    context 'when given postcode with no spaces' do
+      postcode = 'sg80lt'
+
+      it 'should return the court address' do
+        stub_with postcode
+        expect(client.get(postcode)).to eql address
+      end
+    end
+
+    context 'when given postcode with spaces' do
+      postcode = 'SG8 0LT'
+
+      it 'should return the court address' do
+        stub_with postcode
+        expect(client.get(postcode)).to eql address
+      end
+    end
+
+    context 'when invalid postcode is provided' do
+      it 'should return an error' do
+        stub_request(:get, "#{Courtfinder::SERVER}#{Courtfinder::Client::HousingPossession::PATH}fake")
+          .to_return(:status => 200,
+                     :body => '[]',
+                     :headers => {})
+
+        expect(client.get('fake')).to eql '[]'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/helper.rb

@@ -0,0 +1,3 @@
+def fixture(file)
+  File.new(File.expand_path(file, 'spec/support')).read
+end

data/spec/support/result.json

@@ -0,0 +1,35 @@
+[
+    {
+        "name": "Cambridge County Court and Family Court",
+        "address": {
+            "town": "Cambridge",
+            "address_lines": [
+                "Cambridge County Court and Family Court Hearing Centre",
+                "197 East Road"
+            ],
+            "type": "Postal",
+            "postcode": "CB1 1BA",
+            "county": "Cambridgeshire"
+        },
+        "lat": 52.2037125926829,
+        "dx_number": "97650 Cambridge 3",
+        "areas_of_law": [
+            "Forced marriage",
+            "Adoption",
+            "Money claims",
+            "Domestic violence",
+            "Children",
+            "Housing possession",
+            "High court",
+            "Bankruptcy",
+            "Divorce"
+        ],
+        "lon": 0.132065389149123,
+        "number": 162,
+        "types": [
+            "County Court",
+            "Family court"
+        ],
+        "slug": "cambridge-county-court-and-family-court"
+    }
+]

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: courtfinder-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aleksandar Simić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: https://courttribunalfinder.service.gov.uk/ API client
+email:
+- alex.simic@digital.justice.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- courtfinder-client.gemspec
+- lib/courtfinder/client.rb
+- lib/courtfinder/client/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/helper.rb
+- spec/support/result.json
+homepage: https://github.com/ministryofjustice/courtfinder-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Courtfinder client gem
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/helper.rb
+- spec/support/result.json