geonames_client 1.0.0

data/spec/lib/geonames_client/service_definition_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe GeonamesClient::ServiceDefinition do
+
+  let :service_definition do
+    described_class.new
+  end
+
+  context '.address' do
+
+    subject { GeonamesClient::ServiceDefinition.address }
+
+    it { should == 'api.geonames.org' }
+
+  end
+
+  {
+    'base_uri'                 => 'http://api.geonames.org',
+    'nearby_streets_path'      => '/findNearbyStreets',
+    'nearby_streets_json_path' => '/findNearbyStreetsJSON',
+    'latitude_parameter'       => 'lat',
+    'longitude_parameter'      => 'lng',
+    'username_parameter'       => 'username'
+
+  }.each do |method_name, value|
+
+    context "##{method_name}" do
+
+      subject { service_definition.send( method_name ) }
+
+      it { should == value  }
+
+    end
+
+  end
+
+  context '#nearby_streets_base_path' do
+
+    {
+      :xml   => 'http://api.geonames.org/findNearbyStreets',
+      :json  => 'http://api.geonames.org/findNearbyStreetsJSON',
+      'xml'  => 'http://api.geonames.org/findNearbyStreets',
+      'json' => 'http://api.geonames.org/findNearbyStreetsJSON'
+    }.each do |format, value|
+
+      context "when #{format} requested" do
+
+        subject { service_definition.nearby_streets_base_path( format ) }
+
+        it { should == value  }
+
+      end
+
+    end
+
+    it "should raise an exception when the format is not an avaliable format" do
+      lambda { service_definition.nearby_streets_base_path( :html ) }.should(
+        raise_error( RuntimeError, /^Invalid format: expected one of .*/ )
+      )
+    end
+
+  end
+
+  context '#full_nearby_streets_uri' do
+
+    let :params do
+      {
+        :latitude  => '29.762242',
+        :longitude => '-95.416166',
+        :username  => 'ncite'
+      }
+    end
+
+    context 'when given all expected paramaters in a hash' do
+
+      context 'and no format is provided do' do
+
+        subject { service_definition.full_nearby_streets_uri( params ) }
+
+        it { should == 'http://api.geonames.org/findNearbyStreets?lat=29.762242&lng=-95.416166&username=ncite' }
+
+      end
+
+      context 'and a format of :xml is provided do' do
+
+        subject { service_definition.full_nearby_streets_uri( params.merge( :format => :xml ) ) }
+
+        it { should == 'http://api.geonames.org/findNearbyStreets?lat=29.762242&lng=-95.416166&username=ncite' }
+
+      end
+
+      context 'and a format of :json is provided do' do
+
+        subject { service_definition.full_nearby_streets_uri( params.merge( :format => :json ) ) }
+
+        it { should == 'http://api.geonames.org/findNearbyStreetsJSON?lat=29.762242&lng=-95.416166&username=ncite' }
+
+      end
+
+    end
+
+    context 'when not given all of the expected params' do
+
+      %w(
+        latitude
+        longitude
+        username
+      ).each do |parameter|
+
+        it "should raise an exception when the #{parameter} parameter is not provided" do
+          lambda { service_definition.full_nearby_streets_uri( params.except( parameter.to_sym ) ) }.should(
+            raise_error( RuntimeError, "Please provide the :#{parameter} parameter" )
+            )
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/geonames_client/service_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe GeonamesClient::Service do
+
+  let :service do
+    described_class.new( 'test' )
+  end
+
+  it "should include the HTTParty module" do
+    described_class.included_modules.should include( HTTParty )
+  end
+
+  it "should have a service definition" do
+    service.service_definition.is_a?( GeonamesClient::ServiceDefinition ).should be_true
+  end
+
+  context '#initialize' do
+
+    context "accepting an api_key" do
+
+      subject { described_class.new( 'test' ).api_key }
+
+      it { should == 'test' }
+
+    end
+
+  end
+
+  context '#get_nearby_streets' do
+
+    before :each do
+      service.stub!( :nearby_streets ).and_return street_names
+    end
+
+    let :http_party_response do
+      base = File.join( File.dirname(__FILE__), "..", "..", "data" )
+
+      HTTParty::Response.new YAML::load_file( File.join( base, "geoname_response-headers.yml" ) ),
+                             YAML::load_file( File.join( base, "geoname_response-response.yml" ) ),
+                             YAML::load_file( File.join( base, "geoname_response-parsed_response.yml" ) )
+    end
+
+    let :street_names do
+      ["Detering St", "Memorial Dr", "Aloe St", "Hohl St"]
+    end
+
+    subject do
+      service.get_nearby_streets( :latitude  => '29.762242',
+                                  :longitude => '-95.416166' )
+    end
+
+    it { should == GeonamesClient::NearbyStreet.all( 'Aloe St',
+                                                     'Detering St',
+                                                     'Hohl St',
+                                                     'Memorial Dr' ) }
+
+  end
+
+  # context '#nearby_streets_from_geonames_northeast' do
+  #
+  #   subject do
+  #     service.nearby_streets_from_geonames_northeast( :latitude  => '29.762242',
+  #                                                     :longitude => '-95.416166' )
+  #   end
+  #
+  #   it { should == nil }
+  #
+  # end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'geonames_client'
+
+RSpec.configure do |config|
+
+  config.mock_with :rspec
+
+end
+
+class Hash
+  # for excluding keys
+  def except(*exclusions)
+    self.reject { |key, value| exclusions.include? key.to_sym }
+  end
+
+  # for overriding keys
+  def with(overrides = {})
+    self.merge overrides
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification 
+name: geonames_client
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- C. Jason Harrelson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 10
+        - 4
+        version: 0.10.4
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 4
+        - 2
+        version: 0.4.2
+  type: :development
+  version_requirements: *id005
+description: A client to consume the geonames web services (www.geonames.org).
+email: 
+- jason@lookforwardenterprises.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- README.rdoc
+- Rakefile
+- geonames_client.gemspec
+- lib/geonames_client.rb
+- lib/geonames_client/_location.rb
+- lib/geonames_client/location.rb
+- lib/geonames_client/nearby_street.rb
+- lib/geonames_client/service.rb
+- lib/geonames_client/service_definition.rb
+- lib/geonames_client/version.rb
+- spec/data/geoname_response-headers.yml
+- spec/data/geoname_response-parsed_response.yml
+- spec/data/geoname_response-response.yml
+- spec/lib/geonames_client/location_spec.rb
+- spec/lib/geonames_client/nearby_street_spec.rb
+- spec/lib/geonames_client/service_definition_spec.rb
+- spec/lib/geonames_client/service_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: geonames_client
+rubygems_version: 1.6.0
+signing_key: 
+specification_version: 3
+summary: A client to consume the geonames web services.
+test_files: 
+- spec/data/geoname_response-headers.yml
+- spec/data/geoname_response-parsed_response.yml
+- spec/data/geoname_response-response.yml
+- spec/lib/geonames_client/location_spec.rb
+- spec/lib/geonames_client/nearby_street_spec.rb
+- spec/lib/geonames_client/service_definition_spec.rb
+- spec/lib/geonames_client/service_spec.rb
+- spec/spec_helper.rb