zipcode_lookup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cd0af33900a08099de51d6f019f82c8552bfad5
+  data.tar.gz: 4050178bc8adde597f84b4554c07800531bb676e
+SHA512:
+  metadata.gz: 8ccffe8e1eccb9f18c052da3fae6b328cf0b89670519823c0282a81f7180b0b813cfb4006c51a90721369b28057e943d84e785da26e593f5ec0967c49520e636
+  data.tar.gz: a0cca7a4fd98b18446b418a55c2410511b2894afc0c81e63b078906e9dd2e6941efc205d2eae3f98a9bf32ddcfb6bd2b20d88348546f205f47d650b0a39962c2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Abhijit Sinha
+
+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,39 @@
+# ZipcodeLookup
+
+Welcome to zipcode lookup. This gem fetches geo-details via zipcode lookup. It uses couple of API - Google and Ziptastic for fetching geo-details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zipcode_lookup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zipcode_lookup
+
+## Usage
+
+TODO: Sanitize and Validate the zipcode before process.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/[USERNAME]/zipcode_lookup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zipcode_lookup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/lib/lookup/base.rb

@@ -0,0 +1,33 @@
+require 'net/http'
+require 'ostruct'
+require 'uri'
+require 'json'
+
+module Lookup
+  class Base
+    attr_accessor :geo_obj, :response, :response_obj, :zipcode
+
+    def self.process(zipcode, options = {})
+      new(zipcode, options).process
+    end
+
+    def api_request
+      Net::HTTP.get(parsed_url)
+    end
+
+    def initialize(zipcode, options = {})
+      @zipcode = zipcode
+    end
+
+    def parsed_url
+      URI.parse(search_url)
+    end
+
+    def process
+      begin
+        self.response = api_request
+      rescue
+      end
+    end
+  end
+end

data/lib/lookup/google_lookup.rb

@@ -0,0 +1,49 @@
+require 'lookup/base'
+
+module Lookup
+  class GoogleLookup < Base
+    attr_accessor :api_key, :region
+
+    GEO_HASH = {
+      'city'     => 'locality',
+      'state'    => 'administrative_area_level_1',
+      'county'   => 'administrative_area_level_2',
+      'country'  => 'country'
+    }
+
+    def initialize(zipcode, options = {})
+      super
+      @api_key = options[:api_key]
+      @region  = options[:region]
+    end
+
+    def search_url
+      "http://maps.googleapis.com/maps/api/geocode/json?address=#{zipcode}&region=#{region}&key=#{api_key}"
+    end
+
+    def process
+      super
+      fetch_response
+      build_geo_details
+    end
+
+    def fetch_response
+      self.response = JSON.parse(response)['results'].first
+    end
+
+    def build_geo_details
+      self.response_obj = OpenStruct.new(response)
+      self.geo_obj      = OpenStruct.new
+      GEO_HASH.keys.each do |key|
+        address_component_value = fetch_address_component(GEO_HASH[key])
+        geo_obj.send("#{key}=", address_component_value)
+      end
+      geo_obj
+    end
+
+    def fetch_address_component(component_name)
+      component_name = response_obj.address_components.find { |x| x['types'].include?(component_name) }
+      component_name and component_name['long_name']
+    end
+  end
+end

data/lib/lookup/ziptastic_lookup.rb

@@ -0,0 +1,23 @@
+require 'lookup/base'
+
+module Lookup
+  class ZiptasticLookup < Base
+    def search_url
+      "http://ziptasticapi.com/#{zipcode}"
+    end
+
+    def process
+      super
+      fetch_response
+      build_geo_details
+    end
+
+    def fetch_response
+      self.response = JSON.parse(response)
+    end
+
+    def build_geo_details
+      OpenStruct.new(response)
+    end
+  end
+end

data/lib/zipcode_lookup.rb

@@ -0,0 +1,11 @@
+require "zipcode_lookup/version"
+require "lookup/google_lookup"
+require "lookup/ziptastic_lookup"
+
+module ZipcodeLookup
+  def self.fetch_details(zip, options = {})
+    ziptastic_response = Lookup::ZiptasticLookup.process(zip)
+    return ziptastic_response unless ziptastic_response.error
+    Lookup::GoogleLookup.process(zip, options)
+  end
+end

data/lib/zipcode_lookup/version.rb

@@ -0,0 +1,3 @@
+module ZipcodeLookup
+  VERSION = "0.1.0"
+end

data/zipcode_lookup.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zipcode_lookup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zipcode_lookup"
+  spec.version       = ZipcodeLookup::VERSION
+  spec.authors       = ["Abhijit Sinha"]
+  spec.email         = ["abhijit.sinha@kiprosh.com"]
+
+  spec.summary       = %q{Gem to fetch geo details via zipcode}
+  spec.description   = %q{This gem uses the ziptastic api and google api to fetch the geo details via zipcode}
+  spec.homepage      = "http://www.abhijitsinha.me"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: zipcode_lookup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abhijit Sinha
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem uses the ziptastic api and google api to fetch the geo details
+  via zipcode
+email:
+- abhijit.sinha@kiprosh.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lookup/base.rb
+- lib/lookup/google_lookup.rb
+- lib/lookup/ziptastic_lookup.rb
+- lib/zipcode_lookup.rb
+- lib/zipcode_lookup/version.rb
+- zipcode_lookup.gemspec
+homepage: http://www.abhijitsinha.me
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Gem to fetch geo details via zipcode
+test_files: []