craftyclicks-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbb10e26b99dd6302a6600c2f5d955754c03204b
+  data.tar.gz: 76345592331b38fb0326f1d6bf86a309102fb083
+SHA512:
+  metadata.gz: de2cfffb1a2afe2aade12e0470b107c1f5ff80b938a60358b39b92fbd17832c519f5dde70f5d6b1354f6ba25977e56cd881762225fe1f026cc055430006d5b32
+  data.tar.gz: 769c5b0668542fc3c8262fb790ba13e5561cd7190afbecadcab6f2fca1436b968bb828afdae2b48e1bc046e2507cf96d45d35c7d549f357be9dea0b3974e430b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/.rubocop.yml

@@ -0,0 +1,164 @@
+# Relaxed.Ruby.Style
+## Version 2.0
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+
+Style/DotPosition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
+
+Style/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespacebeforeblockbraces
+
+Style/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainarguments
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainliteral
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1
+  - 2.2.5
+  - 2.3.3
+  - 2.4.1
+
+cache: bundler
+before_install: gem update
+script: bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Joseph Southan
+
+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,69 @@
+# CraftyClicks
+[![Build Status](https://travis-ci.org/JoeSouthan/craftyclicks-ruby.svg?branch=master)](https://travis-ci.org/JoeSouthan/craftyclicks-ruby)
+[![Code Climate](https://codeclimate.com/github/JoeSouthan/craftyclicks-ruby/badges/gpa.svg)](https://codeclimate.com/github/JoeSouthan/craftyclicks-ruby)
+
+A simple wrapper around the CraftyClicks APIs 🌍
+
+[ClickToAddress](https://craftyclicks.co.uk/docs/global/#json-api) | [RapidAddress](https://craftyclicks.co.uk/docs/postcode-lookup/#json-api)
+
+This is a WIP, expect the implementation to change
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'craftyclicks-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install craftyclicks-ruby
+
+## Usage
+
+Set your API key
+
+```ruby
+require 'crafty_clicks'
+
+CraftyClicks.configure do |c|
+  c.api_key = 'API_KEY'
+end
+
+```
+
+### [Address lookup](https://craftyclicks.co.uk/docs/global/#json-api):
+
+```ruby
+CraftyClicks::AddressLookup.find(query: 'Buckingham Palace', country: 'GB')
+CraftyClicks::AddressLookup.retrieve(id: '26086283', country: 'GB')
+```
+
+### [Postcode lookup](https://craftyclicks.co.uk/docs/postcode-lookup/#json-api)
+
+```ruby
+CraftyClicks::PostcodeLookup.full_address(postcode: 'AA11AA')
+CraftyClicks::PostcodeLookup.basic_address(postcode: 'AA11AA')
+CraftyClicks::PostcodeLookup.geocode(postcodes: ['AA11AA', 'AA11AB'])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/JoeSouthan/craftyclicks-ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'crafty_clicks'
+
+CraftyClicks.configure do |c|
+  c.api_key = 'API_KEY'
+end
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/crafty_clicks.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crafty_clicks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'craftyclicks-ruby'
+  spec.version       = CraftyClicks::VERSION
+  spec.authors       = ['Joseph Southan']
+  spec.email         = ['joe+github@sthn.io']
+
+  spec.summary       = 'A simple wrapper around the CraftClicks API'
+  spec.homepage      = 'https://www.github.com/JoeSouthan/craftyclicks-ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 3'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'fuubar', '~> 2.2'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.6'
+  spec.add_dependency 'rest-client', '~> 1.8'
+  spec.add_dependency 'oj', '~> 2.18.5'
+end

data/lib/crafty_clicks/address_lookup.rb

@@ -0,0 +1,31 @@
+module CraftyClicks
+  class AddressLookup
+    def self.find(query:, country:, id: nil, ip_address: nil, coords: [])
+      ApiBase.new(
+        product: :address,
+        service: :find,
+        http_method: :post,
+        params: {
+          query: query,
+          country: country,
+          id: id,
+          ip: ip_address,
+          coords: coords
+        },
+      ).perform_request
+    end
+
+    def self.retrieve(country:, id:, lines: 2)
+      ApiBase.new(
+        product: :address,
+        service: :retrieve,
+        http_method: :post,
+        params: {
+          country: country,
+          id: id,
+          lines: lines
+        },
+      ).perform_request
+    end
+  end
+end

data/lib/crafty_clicks/api_base/exceptions.rb

@@ -0,0 +1,7 @@
+module CraftyClicks
+  class ApiBase
+    class Exceptions
+      class ApiError < RuntimeError; end
+    end
+  end
+end

data/lib/crafty_clicks/api_base.rb

@@ -0,0 +1,41 @@
+require 'rest-client'
+require 'oj'
+
+module CraftyClicks
+  class ApiBase
+    attr_accessor :result
+    ADDRESS_ENDPOINT = 'https://api.craftyclicks.co.uk/address/1.1'.freeze
+    POSTCODE_ENDPOINT = 'http://pcls1.craftyclicks.co.uk/json'.freeze
+
+    def initialize(product:, service:, params: {}, http_method: :get)
+      @product = self.class.const_get("#{product.upcase}_ENDPOINT")
+      @service = service
+      @params = params.merge(key: CraftyClicks.configuration.api_key)
+      @http_method = http_method
+    end
+
+    def perform_request
+      process_result(
+        RestClient::Request.execute(
+          method: @http_method,
+          url: "#{@product}/#{@service}",
+          payload: @params.to_json,
+          headers: { content_type: :json, accept: :json }
+        )
+      )
+    rescue RestClient::Unauthorized, RestClient::Forbidden, RestClient::ResourceNotFound => ex
+      raise Exceptions::ApiError.new(ex.response), "Unauthorized: #{ex.response}"
+    rescue RestClient::InternalServerError => ex
+      raise Exceptions::ApiError.new(ex.response), "Server error: #{ex.response}"
+    end
+
+    private
+
+    def process_result(request)
+      @result = Oj.safe_load(request)
+      @result = @result.is_a?(Array) ? { 'results' => @result } : @result
+      raise Exceptions::ApiError.new(result), "API Error: #{result}" if @result.keys.map { |k| k =~ /error/ }.any?
+      @result
+    end
+  end
+end

data/lib/crafty_clicks/configuration.rb

@@ -0,0 +1,5 @@
+module CraftyClicks
+  class Configuration
+    attr_accessor :api_key
+  end
+end

data/lib/crafty_clicks/postcode_lookup.rb

@@ -0,0 +1,48 @@
+module CraftyClicks
+  class PostcodeLookup
+    attr_accessor :postcode, :geocode, :sort, :response_format, :lines
+
+    def initialize(service, args)
+      @service = service
+      @args = args
+    end
+
+    def self.full_address(*args)
+      new(:rapidaddress, args).make_request
+    end
+
+    def self.basic_address(*args)
+      new(:basicaddress, args).make_request
+    end
+
+    def self.geocode(postcodes: [], distance: {}, preserve_index: true)
+      ApiBase.new(
+        product: :postcode,
+        service: :geocode,
+        http_method: :post,
+        params: {
+          postcodes: postcodes,
+          distance: distance,
+          preserve_index: preserve_index
+        },
+      ).perform_request
+    end
+
+    def make_request
+      postcode, geocode, sort, response_format, lines = *@args
+
+      ApiBase.new(
+        product: :postcode,
+        service: @service,
+        http_method: :post,
+        params: {
+          postcode: postcode,
+          include_geocode: geocode,
+          sort: sort,
+          response: response_format,
+          lines: lines,
+        }
+      ).perform_request
+    end
+  end
+end

data/lib/crafty_clicks/version.rb

@@ -0,0 +1,3 @@
+module CraftyClicks
+  VERSION = '0.1.0'.freeze
+end

data/lib/crafty_clicks.rb

@@ -0,0 +1,21 @@
+require 'crafty_clicks/address_lookup'
+require 'crafty_clicks/api_base'
+require 'crafty_clicks/api_base/exceptions'
+require 'crafty_clicks/configuration'
+require 'crafty_clicks/postcode_lookup'
+require 'crafty_clicks/version'
+
+module CraftyClicks
+  class << self
+    attr_accessor :api_key
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: craftyclicks-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Southan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.5
+description: 
+email:
+- joe+github@sthn.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crafty_clicks.gemspec
+- lib/crafty_clicks.rb
+- lib/crafty_clicks/address_lookup.rb
+- lib/crafty_clicks/api_base.rb
+- lib/crafty_clicks/api_base/exceptions.rb
+- lib/crafty_clicks/configuration.rb
+- lib/crafty_clicks/postcode_lookup.rb
+- lib/crafty_clicks/version.rb
+homepage: https://www.github.com/JoeSouthan/craftyclicks-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A simple wrapper around the CraftClicks API
+test_files: []