zipcodeservices 0.0.0 → 0.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Mjg3MzkyOTBlMzZkNGE4Y2NhZTgzZmIzZTRlZWMwY2FjMTZhZjNiMg==
+    MjI5MDFjZTFmMzRmODg5OGVmNzk3YmVhODI5NTJkYTNkMmVkODdkNg==
   data.tar.gz: !binary |-
-    YTE5ZGVlNzUwZTQ1ZTNlMjJkNzY5OTEzYzIyNmVjZmViOTM1MGEzYw==
+    ZWNhZmE2YWIyMGM5ZTM1YjlkNDU4NDEyNWZiNjhhMGRjNDJlMjI2NQ==
 SHA512:
   metadata.gz: !binary |-
-    MDE4ZTNkYjA0ZmM5ZjUxZDJmNjQ1NGQ0ODU1ZjcyZjA2ZTQwYTI5YTc2OWM2
-    ODg5MjVhMjgzNmY1ZjA3YmY4YmY4YmQwNjc2MGM4ZjdkMGM5NGJkYjE5ZTZi
-    YjMzZjBlZTg4N2RmODg3ZjZkNjJkNTQyNGJhYjk2OWIzOWJjNmM=
+    MjZiZTBiNzlmZTE3NzBkMDAxMjkyMTE1MDM3ZTcyOTc1YzgwOThhMmM4MThm
+    ODM0MmE3ODFmNWI3MDE2ZDg2MTJkMzY3YjAzMmMwMzBhOTE0ZjAwNzVmYmIy
+    ZDMxMjkyNDE2MzZmMmE1MTczNTdhNGQ3ZjZlNmNlZDMyZTlkZTI=
   data.tar.gz: !binary |-
-    Y2NkMGM3NmVlNmEzOGI1NjEwYmMzZGMyOWRkYjNmZTM0YmY2MjBmNjFmZDQ2
-    MGU5NzE1MmRjY2U2YzU4NzAwOTYxYTNiZjJiNzRkZDgxMGRiODZjMjRmN2Ri
-    NmU4ZTMzNzFkMWQ4OTFlZTEzMjJjOWFiZjdmMzg4ZWU3OWZhNTk=
+    YThlYTg4NWQ3MWI1MTlhNjc1YjBkNTdmNmJiZWU3ZGRiOTEzOGQyNDI4NjIx
+    OGQwZjUwODVlYzk3MjRmYzUwNmVmYTg0ODZkN2MzYmUzMTE5ZDZlODY2OWRh
+    ZjNhZjI5ZDZiM2RkZTEyMmU3OGQwYzViM2FlZjRkY2Y0MjAzMWU=

data/.gitignore

@@ -0,0 +1,32 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# br operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+*_Store
+/.rvmrc
+/.ruby-gemset
+coverage
+config/database.yml
+/public/uploads
+.*.swp
+.env
+*.gem
+/spec/vcr_cassettes/*

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    zipcodeservices (0.0.1)
+      typhoeus (= 0.3.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    celluloid-io (0.15.0)
+      celluloid (>= 0.15.0)
+      nio4r (>= 0.5.0)
+    coderay (1.1.0)
+    columnize (0.8.9)
+    debugger (1.6.6)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.2)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.2)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.6.0)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.2.8)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    listen (2.7.4)
+      celluloid (>= 0.15.2)
+      celluloid-io (>= 0.15.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.5)
+    method_source (0.8.2)
+    mime-types (2.2)
+    nio4r (1.0.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.4)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    slop (3.5.0)
+    thor (0.19.1)
+    timers (1.1.0)
+    typhoeus (0.3.3)
+      mime-types
+    vcr (2.2.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  guard-rspec
+  rspec (~> 2.13)
+  vcr
+  zipcodeservices!

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/lib/zipcodeservices/version.rb

@@ -0,0 +1,3 @@
+module ZipCodeServices
+  VERSION = '0.0.1'
+end

data/lib/zipcodeservices.rb

@@ -0,0 +1,130 @@
+# Require the necessary files
+%w[
+  rubygems
+  typhoeus
+].each { |r| require r }
+
+module ZipCodeServices
+  @base_uri = 'https://www.zipcodeservices.com/services/rest/json' #/zipcodes.svc'
+
+  class << self; 
+    #attr_accessor :base_uri 
+    attr_accessor :apikey
+
+    def zipcode(zip) 
+      #/{apikey}/{zipcode}
+      response = Typhoeus::Request.get( "#{@base_uri}/zipcodes.svc/#{apikey}/#{zip}") 
+      if response.code == 200 
+        j = JSON::parse(response.body)
+        raise "BAD API KEY" if j.first[1]["City"] == nil 
+        j
+      elsif response.code == 404
+        nil 
+      else 
+        raise response.body 
+      end 
+    end
+
+    def radius(zip, rad)
+      #/{apikey}/{zipcode}
+      response = Typhoeus::Request.get( "#{@base_uri}/zipcodes.svc/#{apikey}/#{zip}/#{rad}") 
+      if response.code == 200 
+        j = JSON::parse(response.body)
+        raise "BAD API KEY" if j["RetrieveZipCodesInRadiusResult"] == nil 
+        j
+      elsif response.code == 404
+        nil 
+      else 
+        raise response.body 
+      end 
+    end
+
+    def radius_by_latlong(lat, long, rad)
+      #/{apikey}/{zipcode}
+      response = Typhoeus::Request.get( "#{@base_uri}/zipcodes.svc/GetZipCodesInRadiusLatLong?apikey=#{apikey}&latitude=#{lat}&longitude=#{lon}&radius=#{rad}") 
+      if response.code == 200 
+        j = JSON::parse(response.body)
+        raise "BAD API KEY" if j["GetZipCodesInRadiusOfLatLongResult"] == nil 
+        j
+      elsif response.code == 404
+        nil 
+      else 
+        raise response.body 
+      end 
+    end
+
+    def distance_between_zipcodes(zip1, zip2) 
+      #/{apikey}/{zipcode}
+      response = Typhoeus::Request.get( "#{@base_uri}/zipcodes.svc/GetDistanceBetweenZipCodes?apikey=#{apikey}&zipcode1=#{zip1}&zipcode2=#{zip2}") 
+      if response.code == 200 
+        j = JSON::parse(response.body)
+        raise "BAD API KEY" if j.first[1]["ZipCode1"] == nil 
+        j
+      elsif response.code == 404
+        nil 
+      else 
+        raise response.body 
+      end 
+    end
+
+    def countries
+      #/{apikey}/{zipcode}
+      response = Typhoeus::Request.get( "#{@base_uri}/countries.svc/#{apikey}") 
+      if response.code == 200 
+        j = JSON::parse(response.body)
+        raise "BAD API KEY" if j["GetCountriesResult"] == nil 
+        j
+      elsif response.code == 404
+        nil 
+      else 
+        raise response.body 
+      end 
+    end
+
+    def states(country_id)
+      #/{apikey}/{zipcode}
+      response = Typhoeus::Request.get( "#{@base_uri}/provinces.svc/#{apikey}/#{country_id}") 
+      if response.code == 200 
+        j = JSON::parse(response.body)
+        raise "BAD API KEY" if j["GetAllProvincesByCountryIdResult"] == nil 
+        j
+      elsif response.code == 404
+        nil 
+      else 
+        raise response.body 
+      end 
+    end
+    alias :provinces :states
+
+    def cities(province_id)
+      #/{apikey}/{zipcode}
+      response = Typhoeus::Request.get( "#{@base_uri}/cities.svc/#{apikey}/#{province_id}") 
+      if response.code == 200 
+        j = JSON::parse(response.body)
+        raise "BAD API KEY" if j["GetCitiesByProvinceResult"] == nil 
+        j
+      elsif response.code == 404
+        nil 
+      else 
+        raise response.body 
+      end 
+    end
+
+    def cities_by_state_and_country(province_id, country_id)
+      #/{apikey}/{zipcode}
+      response = Typhoeus::Request.get( "#{@base_uri}/cities.svc/#{apikey}/#{province_id}/#{country_id}") 
+      if response.code == 200 
+        j = JSON::parse(response.body)
+        raise "BAD API KEY" if j["GetCitiesByProvinceAndCountryResult"] == nil # NOTE: also happens when a province id is not valid for a country
+        j
+      elsif response.code == 404
+        nil 
+      else 
+        raise response.body 
+      end 
+    end
+
+
+  end 
+end
+

data/spec/client_spec.rb

@@ -0,0 +1,52 @@
+require 'zipcodeservices'
+require 'spec_helper'
+
+describe "client" do 
+
+  before(:each) do
+    ZipCodeServices.apikey = 'YOUR_API_KEY_HERE'
+  end
+
+  it "should retrieve zip code info", :vcr, record: :new_episodes do 
+    zips = ZipCodeServices.zipcode("78702") 
+    zips.first[1]["City"].should == "Austin" 
+    # test other item 
+  end
+
+  it "should get zip codes in radius of zip code", :vcr,  record: :new_episodes do
+    zips = ZipCodeServices.radius(78702, 1)
+    zips.first[1].first["PostalCode"].should == "78701"
+  end
+
+  it "should get zip codes in radius of latitude and longitude", :vcr,  record: :new_episodes do
+    zips = ZipCodeServices.radius_by_latlong("30.2645715", "-97.7284341", 1)
+    zips.first[1].first["PostalCode"].should == "73301"
+  end
+
+  it "should get the distance between zip codes", :vcr,  record: :new_episodes do
+    zips = ZipCodeServices.distance_between_zipcodes("78702", "01109")
+    zips.first[1]["DistanceAwayInMiles"].should == 1616.501295
+  end
+
+
+  it "should get countries", :vcr,  record: :new_episodes do
+    countries = ZipCodeServices.countries
+    countries.first[1].first["Abbreviation"].should == "US"
+  end
+
+  it "should get states / provinces by country id (country id attained by request to countries list)", :vcr,  record: :new_episodes do
+    states = ZipCodeServices.states(1)
+    states.first[1].first["Abbreviation"].should == "AL"
+  end
+
+  it "should get cities by province id / provinces id (country id attained by request to states list)", :vcr,  record: :new_episodes do
+    cities = ZipCodeServices.cities(200)
+    cities.first[1].first["City"].should == "Alamo"
+  end
+
+  it "should get cities by state id (provinces id) and country id (country id attained by request for country list, province id attained by request for states list)", :vcr,  record: :new_episodes do
+    cities = ZipCodeServices.cities_by_state_and_country(1, 1)
+    cities.first[1][20]["City"].should == "Arlington"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,76 @@
+require 'rspec'
+require 'vcr'
+#require 'webmock/rspec'
+
+VCR.configure do |c|
+  c.allow_http_connections_when_no_cassette = true
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :typhoeus
+end
+
+RSpec.configure do |config|
+
+
+  config.mock_with :rspec
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.around(:each, :vcr) do |example|
+    #name = example.metadata[:full_description].split(/\s+/, 2).join("/").underscore.gsub(/[^\w\/]+/, "_")
+    name = example.metadata[:full_description].split(/\s+/, 2).join("/").downcase.gsub(/\s+/,"_")
+    #options = example.metadata.slice(:record, :match_requests_on).except(:example_group)
+    options = example.metadata.reduce({}){ |acc, x| [:record,:match_requests_on].include?(x[0]) ? acc.merge({x[0] => x[1]}) : acc } 
+    VCR.use_cassette(name, options) { example.call }
+    #VCR.use_cassette(name) { example.call }
+  end
+
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+
+  #WebMock.disable_net_connect!(:allow => 'coveralls.io')
+
+  #RSpec.configure do |config|
+  #  config.expect_with :rspec do |c|
+  #    c.syntax = :expect
+  #  end
+  #end
+
+  #def a_delete(path)
+  #  a_request(:delete, ZipCodeServices::base_uri + path)
+  #end
+
+  #def a_get(path)
+  #  a_request(:get, ZipCodeServices::base_uri + path)
+  #end
+
+  #def a_post(path)
+  #  a_request(:post, ZipCodeServices::base_uri + path)
+  #end
+
+  #def a_put(path)
+  #  a_request(:put, ZipCodeServices::base_uri + path)
+  #end
+
+  #def stub_delete(path)
+  #  stup_request(:delete, ZipCodeServices::base_uri + path)
+  #end
+
+  #def stub_get(path)
+  #  stup_request(:get, ZipCodeServices::base_uri + path)
+  #end
+
+  #def stub_post(path)
+  #  stup_request(:post, ZipCodeServices::base_uri + path)
+  #end
+
+  #def stub_put(path)
+  #  stup_request(:put, ZipCodeServices::base_uri + path)
+  #end
+
+
+end

data/spec/support/vcr_setup.rb

@@ -0,0 +1,8 @@
+VCR.configure do |c|
+  # temporarily allows calls to go directly to facebook
+  #c.ignore_hosts 'facebook.com', 'graph.facebook.com'
+  
+  c.cassette_library_dir  = Rails.root.join("spec", "vcr")
+  #c.hook_into :fakeweb
+  c.hook_into :typheous
+end

data/zipcodeservices.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "zipcodeservices/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'zipcodeservices'
+  s.version     = ZipCodeServices::VERSION 
+  s.platform    = Gem::Platform::RUBY
+  s.date        = '2014-05-06'
+  s.summary     = "zipcodeservices for zipcodeservices.com"
+  s.description = "Ruby Client for zipcodeservices.com.  Gives ip address and radius queries.  Visit zipcodeservices.com for more details"
+  s.authors     = ["W Watson", "T Carpenter"]
+  s.email       = 'wolfpack@vulk.com'
+  s.files       = ["lib/zipcodeservices.rb"]
+  s.homepage    = 'http://rubygems.org/gems/zipcodeservices'
+  s.license       = 'MIT'
+  s.required_ruby_version = '>= 1.9.3'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec', ["~> 2.13"]
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'debugger'
+
+  s.add_runtime_dependency "typhoeus", "0.3.3"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipcodeservices
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - W Watson
@@ -26,7 +26,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.13'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -53,6 +53,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  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'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +87,17 @@ email: wolfpack@vulk.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- lib/zipcodeservices.rb
+- lib/zipcodeservices/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr_setup.rb
+- zipcodeservices.gemspec
 homepage: http://rubygems.org/gems/zipcodeservices
 licenses:
 - MIT
@@ -98,4 +122,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: zipcodeservices for zipcodeservices.com
-test_files: []
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr_setup.rb