crafty_clicks 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9221c4075b97109bf68b53e150ab561e442ad826
+  data.tar.gz: cfe49bd4a8bc5638f9b27a9f0fbaa400ae5a6a00
+SHA512:
+  metadata.gz: 8016e8b8bd7bf11f1fd2165a8448429c78e7e1e8a423152466afca24435139f3b420555a9fefab5b8a1bb379622aa2d068f10fc53657d4355629af6e651e5f0e
+  data.tar.gz: a507fd34f1bcea2cbcb934c14438b76d5d924f034224dd4ff175bb1660819a13fa03ba08ab50350d0544c1e45d13e4aa65302526c35326f559f5891c65dc111c

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Malet
+
+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,73 @@
+# CraftyClicks
+
+This gem allows you to use the Crafty Clicks Address lookup API in your Rails apps (and also in plain Ruby).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crafty_clicks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crafty_clicks
+
+## Usage
+
+### Basic Example
+
+```ruby
+[1] pry(main)> cc = CraftyClicks.new(key: 'your-api-key', env: :production)
+# => #<CraftyClicks:0x000001061ea648 @env=:production, @key="your-api-key">
+
+[2] pry(main)> cc.lookup_postcode('aa11aa')
+# => {:addresses=>
+#   ["LITTLE COTTAGE 17 HIGH STREET",
+#    "BIG HOUSE HIGH STREET",
+#    "1 HIGH STREET",
+#    "3 HIGH STREET",
+#    "7 HIGH STREET"],
+#  :town=>"BIG CITY",
+#  :postcode=>"AA1 1AA"}
+```
+
+### Advanced Example
+
+```ruby
+class Address
+  def self.lookup_provider
+    @@provider ||= CraftyClicks.new(
+      key: Rails.application.secrets.crafty_clicks_key,
+      env: Rails.env.to_sym
+    )
+  end
+
+  def self.find_by(postcode:)
+    raise 'Must provide a postcode' if postcode.blank?
+    lookup_provider.lookup_postcode postcode
+  end
+end
+
+[1] pry(main)> Address.find_by(postcode: 'aa11ab')
+# => {:addresses=>
+#   ["LITTLE HOUSE CRAFTYIER ROAD",
+#    "CUTE HOUSE CRAFTYIER ROAD",
+#    "SMALL COTTAGE CRAFTYIER ROAD",
+#    "1C, CRAFTY HOUSE A BUSINESS CENTRE, CRAFTY ROAD",
+#    "1B, CRAFTY HOUSE A BUSINESS CENTRE, CRAFTY ROAD",
+#    "1A, CRAFTY HOUSE A BUSINESS CENTRE, CRAFTY ROAD"],
+#  :town=>"BIG CITY",
+#  :postcode=>"AA1 1AB"}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/crafty_clicks/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/crafty_clicks.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "crafty_clicks"
+  spec.version       = '0.0.7'
+  spec.authors       = ["Michael Malet"]
+  spec.email         = ["michael@nervd.com"]
+  spec.summary       = %q{Crafty Clicks - Addresses by Postcode}
+  spec.description   = %q{This gem interfaces with Crafty Clicks' JSONP API}
+  spec.homepage      = "https://github.com/malet/crafty_clicks"
+  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", '~> 0'
+end

data/lib/crafty_clicks.rb

@@ -0,0 +1,66 @@
+require 'json'
+require 'uri'
+require 'net/http'
+
+class CraftyClicks
+  RAPID_URL = 'http://pcls1.craftyclicks.co.uk/json/rapidaddress'
+
+  def initialize(key:, env: :test)
+    # Only set the auth key if in production (to avoid unwanted charges)
+    @env = env
+    @key = @env == :production ? key : nil
+  end
+
+  def lookup_postcode(postcode)
+    addresses(lookup_postcode_cached(postcode))
+  end
+
+private
+  
+  def addresses(json)
+    # Format the list of delivery points into a readable list
+    address_list = json['delivery_points'].map do |delivery_point|
+      address = ""
+      address += delivery_point['line_1'] unless delivery_point['line_1']. == ""
+      address += " #{delivery_point['line_2']}" unless delivery_point['line_2']. == ""
+
+      address
+    end.sort do |a1, a2|
+      # Sort by house number where possible
+      a1.match(/^[0-9]+/).try(:[], 0).to_i <=>
+      a2.match(/^[0-9]+/).try(:[], 0).to_i
+    end
+
+    {
+      addresses: address_list,
+      town: json['town'],
+      postcode: json['postcode']
+    }
+  end
+
+  def lookup_postcode_uncached(postcode)
+    form_hash = { postcode: postcode, response: 'data_formatted'}
+    form_hash.merge!({ key: @key }) if @key
+    uri = URI(RAPID_URL)
+    uri.query = URI.encode_www_form(form_hash)
+    
+    response = Net::HTTP.get_response(uri)
+    JSON.parse(response.body)
+  end
+
+  def lookup_postcode_cached(postcode)
+    # Automatically use the rails cache if it's available
+    if defined? Rails
+      key = ['craftyclicks', @env, postcode]
+      if cached = Rails.cache.fetch(key)
+        return cached
+      else
+        json = lookup_postcode_uncached(postcode)
+        Rails.cache.write key, json
+        return json
+      end
+    else
+      return lookup_postcode_uncached(postcode)
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: crafty_clicks
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Michael Malet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-21 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem interfaces with Crafty Clicks' JSONP API
+email:
+- michael@nervd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- crafty_clicks.gemspec
+- lib/crafty_clicks.rb
+homepage: https://github.com/malet/crafty_clicks
+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: Crafty Clicks - Addresses by Postcode
+test_files: []
+has_rdoc: