zippopotamus 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f6f4207cd0e0261fd5c8a46db7f3accec6914726
-  data.tar.gz: 6805d33abf5714157272cd596ea668d5c4d48ac1
+SHA256:
+  metadata.gz: c36c6dc9aaaffbd7a9196979d2c359b7849bf88b2bcab247771be3a96fe2a91c
+  data.tar.gz: b33e8f3dcd49ba9c6ef2aebcb4ce6aada87e3320bc51e8a239265f8beebeca7e
 SHA512:
-  metadata.gz: 9a151478bca1796593994c504bfbbf5bcb06e43aba5aa037ea1d8622d02c118d9344fac368fbf4dbec220e0b9d2fdae77336efc3556c2397390d89b309e55911
-  data.tar.gz: 98be9804d4ed5e757916499b8fd513fe90192e827754b9ce2c8030dadd7796e1ab01cf010602a9dcdb58b55cc74a96ec46c0d4257d96a1050e2760cef371a4ed
+  metadata.gz: 1ae9cd9f2448eaa612aaf62aa448a6533b330ad9d93ecf4d7ac714b8e6b89a476c0eb825e0b443e516e4618d56d22cdf4c3983750f8ea5003e72bea60acb984d
+  data.tar.gz: cf3da85cf3341aebe2e06be169658e4aaa610fc850891b5f6ba5fed4b1182087f01fde03e2c30dd7cd58abdf4d5282b6bcb360b77acaaf8a35a86f113a776082

data/.github/FUNDING.yml

@@ -0,0 +1,9 @@
+# These are supported funding model platforms
+
+github: [rmm5t]
+# patreon: # Replace with a single Patreon username
+# open_collective: # Replace with a single Open Collective username
+# ko_fi: # Replace with a single Ko-fi username
+# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+custom: "https://www.paypal.me/rmm5t/5"

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["3.0", "3.1", "3.2", "3.3"]
+
+    steps:
+      # https://github.com/marketplace/actions/checkout
+      - uses: actions/checkout@v4
+      # https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs `bundle install` and caches gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in zippopotamus.gemspec
 gemspec
+
+group :development do
+  gem "guard"
+  gem "guard-minitest"
+end

data/Guardfile

@@ -0,0 +1,8 @@
+# More info at https://github.com/guard/guard#readme
+
+directories %w(lib test)
+
+guard :minitest, bundler: true do
+  watch(%r{^lib/(.+)\.rb$})  { "test" }
+  watch(%r{^test/(.+)\.rb$}) { "test" }
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Ryan McGeary
+Copyright (c) 2015-2018 Ryan McGeary
 
 MIT License
 

data/README.md

@@ -1,10 +1,20 @@
-# Zippopotamus [![Gem Version](http://img.shields.io/gem/v/zippopotamus.svg)](https://rubygems.org/gems/zippopotamus) [![Build Status](https://img.shields.io/travis/rmm5t/zippopotamus.svg)](http://travis-ci.org/rmm5t/zippopotamus)
+# Zippopotamus
 
-Ruby wrapper around the Zippopotam.us API. **Zip Code Galore!** Postal Codes and Zip Codes made easy.
+[![Gem Version](http://img.shields.io/gem/v/zippopotamus.svg)](https://rubygems.org/gems/zippopotamus)
+[![Build Status](https://github.com/rmm5t/zippopotamus/workflows/CI/badge.svg)](https://github.com/rmm5t/zippopotamus/actions?query=workflow%3ACI)
+[![Gem Downloads](https://img.shields.io/gem/dt/zippopotamus.svg)](https://rubygems.org/gems/zippopotamus)
+
+Ruby wrapper around the **[Zippopotam.us](http://zippopotam.us/)** API. **Zip Code Galore!** Postal Codes and Zip Codes made easy.
 
 * Give it a postal code to get back the city, state, longitude, and latitude.
 * Give it a city and state to get back a list of possible postal codes.
 
+## DISCLAIMER: Not Ready Yet, But Some Day
+
+I just started on this gem. It's not real yet. All
+[Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
+so far.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -41,6 +51,12 @@ place.post_code            # => "90201"
 place.longitude            # => "-118.4065"
 place.latitude             # => "34.0901"
 
+# Aliases also exist for code readability
+place.name                 # => "Beverly Hills"
+place.city                 # => "Beverly Hills"
+place.postal_code          # => "90201"
+place.zip                  # => "90201"
+
 # Also aliased as `by_zip`
 places = Zippopotamus.by_zip("90210")
 
@@ -83,3 +99,7 @@ places[1].latitude             # => "42.4128"
 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
+
+## License
+
+[MIT License](https://rmm5t.mit-license.org/)

data/Rakefile

@@ -1,2 +1,11 @@
+require "bundler/setup"
 require "bundler/gem_tasks"
+require "rake/testtask"
 
+desc "Default: run unit tests."
+task default: :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib" << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/zippopotamus/place.rb

@@ -0,0 +1,44 @@
+require "json"
+
+module Zippopotamus
+  class Place
+    def initialize(values = {})
+      @values = values
+      add_readers(values.keys)
+    end
+
+    def [](key)
+      @values[key.to_s.downcase.gsub("_", " ")]
+    end
+
+    def to_s
+      JSON.pretty_generate(@values)
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}> JSON: " + to_s
+    end
+
+    # def self.construct_from(api_body)
+    # end
+
+    private
+
+    METHOD_ALIASES = {
+      place_name: [:name, :city],
+      post_code:  [:postal_code, :zip],
+    }
+
+    def add_readers(keys)
+      singleton_class.instance_eval do
+        keys.each do |key|
+          define_method(key.to_s.downcase.gsub(" ", "_")) { @values[key] }
+        end
+
+        METHOD_ALIASES.each do |method, aliases|
+          aliases.each { |a| alias_method a, method } if method_defined?(method)
+        end
+      end
+    end
+  end
+end

data/lib/zippopotamus/version.rb

@@ -1,3 +1,3 @@
 module Zippopotamus
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/zippopotamus.rb

@@ -1,5 +1,11 @@
 require "zippopotamus/version"
+require "zippopotamus/place"
 
 module Zippopotamus
-  # Your code goes here...
+  def self.by_postal_code(postal_code, country = "us")
+  end
+  singleton_class.send(:alias_method, :by_zip, :by_postal_code)
+
+  def self.by_name(city, state, country = "us")
+  end
 end

data/test/place_test.rb

@@ -0,0 +1,52 @@
+require "test_helper"
+
+class PlaceTest < Minitest::Test
+  def setup
+    @place = Zippopotamus::Place.new(
+      "longitude"            => "-75.6398",
+      "latitude"             => "40.0978",
+      "post code"            => "19425",
+      "place name"           => "Chester Springs",
+      "state"                => "Pennsylvania",
+      "state abbreviation"   => "PA",
+      "country"              => "United States",
+      "country abbreviation" => "US",
+    )
+  end
+
+  def test_should_mimic_a_read_only_hash
+    assert_equal "19425",           @place["post code"]
+    assert_equal "Pennsylvania",    @place["state"]
+    assert_nil @place["bogus"]
+  end
+
+  def test_should_convert_keys_with_spaces_to_underscores
+    assert_equal "19425",           @place["post_code"]
+    assert_equal "PA",              @place["state_abbreviation"]
+    assert_nil @place["something_else"]
+  end
+
+  def test_should_support_indifferent_access
+    assert_equal "19425",           @place[:post_code]
+    assert_equal "PA",              @place[:state_abbreviation]
+    assert_equal "US",              @place[:country_abbreviation]
+  end
+
+  def test_should_support_method_syntax
+    assert_equal "19425",           @place.post_code
+    assert_equal "PA",              @place.state_abbreviation
+    assert_equal "Chester Springs", @place.place_name
+    assert_equal "-75.6398",        @place.longitude
+  end
+
+  def test_should_support_method_aliases
+    assert_equal "19425",           @place.postal_code
+    assert_equal "19425",           @place.zip
+    assert_equal "Chester Springs", @place.name
+    assert_equal "Chester Springs", @place.city
+  end
+
+  def test_should_convert_a_full_zippopotamus_api_response_into_an_array_of_places
+    skip("Zippopotamus::Place.construct_from(api_response)")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require "minitest/autorun"
+require "webmock/minitest"
+require "minitest/reporters"
+if ENV["CI"] == "true"
+  Minitest::Reporters.use! Minitest::Reporters::DefaultReporter.new
+else
+  Minitest::Reporters.use! Minitest::Reporters::ProgressReporter.new
+end
+
+require "zippopotamus"

data/test/zippopotamus_test.rb

@@ -0,0 +1,47 @@
+require "test_helper"
+
+class ZippopotamusTest < Minitest::Test
+  def test_should_exist
+    assert Object.const_defined?(:Zippopotamus)
+  end
+
+  def test_should_respond_to_by_postal_code
+    assert Zippopotamus.respond_to?(:by_postal_code)
+  end
+
+  def test_by_postal_code_should_default_to_us
+    skip("Zippopotamus.by_postal_code('80027')")
+  end
+
+  def test_should_respond_to_by_zip
+    assert Zippopotamus.respond_to?(:by_zip)
+  end
+
+  def test_by_zip_should_alias_by_postal_code
+    skip("Zippopotamus.by_zip('80027')")
+  end
+
+  def test_by_postal_code_should_support_other_countries
+    skip("Zippopotamus.by_postal_code('4400', 'AU')")
+  end
+
+  def test_by_postal_code_should_raise_an_error_when_not_found
+    skip("Zippopotamus.by_zip('80027', 'CA')")
+  end
+
+  def test_should_respond_to_by_name
+    assert Zippopotamus.respond_to?(:by_name)
+  end
+
+  def test_by_name_should_default_to_us
+    skip("Zippopotamus.by_name('Leesburg', 'VA')")
+  end
+
+  def test_by_name_should_support_other_countries
+    skip("Zippopotamus.by_name('Sumburgh', 'SCT', 'GB')")
+  end
+
+  def test_by_name_should_raise_an_error_when_not_found
+    skip("Zippopotamus.by_name('Fake City', 'VA', 'US')")
+  end
+end

data/zippopotamus.gemspec

@@ -4,13 +4,14 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'zippopotamus/version'
 
 Gem::Specification.new do |spec|
+  username           = "rmm5t"
   spec.name          = "zippopotamus"
   spec.version       = Zippopotamus::VERSION
   spec.authors       = ["Ryan McGeary"]
   spec.email         = ["ryan@mcgeary.org"]
-  spec.summary       = "Ruby wrapper around the Zippopotam.us API."
-  spec.description   = "Lookup the city, state, longitude, and latitude for a given country and postal code, or lookup a list of possible postal codes for a given country, state, and city."
-  spec.homepage      = "https://github.com/rmm5t/zippopotamus"
+  spec.summary       = "Ruby wrapper for the Zippopotam.us API"
+  spec.description   = "#{spec.summary}. Lookup the city, state, longitude, and latitude for a given country and postal code, or lookup a list of possible postal codes for a given country, state, and city."
+  spec.homepage      = "https://github.com/#{username}/#{spec.name}"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,9 +19,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "rest-client", "~> 1.4"
+  spec.metadata = {
+    "bug_tracker_uri"   => "#{spec.homepage}/issues",
+    "changelog_uri"     => "#{spec.homepage}/releases",
+    "source_code_uri"   => spec.homepage,
+    "funding_uri"       => "https://github.com/sponsors/#{username}",
+  }
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "rest-client", "~> 1.7"
+
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.5"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3", "> 1.3.1"
+  spec.add_development_dependency "webmock"
+
+  spec.required_ruby_version = ">= 1.9.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zippopotamus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryan McGeary
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,78 +16,109 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.5'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '1.3'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
-description: Lookup the city, state, longitude, and latitude for a given country and
-  postal code, or lookup a list of possible postal codes for a given country, state,
-  and city.
+        version: '1.3'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Ruby wrapper for the Zippopotam.us API. Lookup the city, state, longitude,
+  and latitude for a given country and postal code, or lookup a list of possible postal
+  codes for a given country, state, and city.
 email:
 - ryan@mcgeary.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/zippopotamus.rb
+- lib/zippopotamus/place.rb
 - lib/zippopotamus/version.rb
+- test/place_test.rb
+- test/test_helper.rb
+- test/zippopotamus_test.rb
 - zippopotamus.gemspec
 homepage: https://github.com/rmm5t/zippopotamus
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/rmm5t/zippopotamus/issues
+  changelog_uri: https://github.com/rmm5t/zippopotamus/releases
+  source_code_uri: https://github.com/rmm5t/zippopotamus
+  funding_uri: https://github.com/sponsors/rmm5t
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,16 +126,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
-summary: Ruby wrapper around the Zippopotam.us API.
-test_files: []
+summary: Ruby wrapper for the Zippopotam.us API
+test_files:
+- test/place_test.rb
+- test/test_helper.rb
+- test/zippopotamus_test.rb