reittiopas 0.0.1 → 0.0.2

data/History.txt

@@ -1,4 +1,4 @@
-=== 0.0.1 2010-03-29
+=== 0.0.1 2010-04-05
 
 * 1 major enhancement:
   * Initial release

data/Manifest.txt

@@ -2,9 +2,9 @@ History.txt
 Manifest.txt
 README.rdoc
 Rakefile
-deps.rip
 lib/reittiopas.rb
 lib/reittiopas/coordinates.rb
+lib/reittiopas/exceptions.rb
 lib/reittiopas/geocoding.rb
 lib/reittiopas/http.rb
 lib/reittiopas/location.rb
@@ -14,8 +14,10 @@ script/console
 script/destroy
 script/generate
 spec/fixtures/key.xml
+spec/fixtures/no_access
 spec/fixtures/reverse_geocoding.xml
 spec/reittiopas_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
+tasks/rdoc.rake
 tasks/rspec.rake

data/README.rdoc

@@ -1,6 +1,7 @@
 = Reittiopas
 
 * {Documentation at Github}[http://raneksi.github.com/reittiopas/]
+* {Specifications}[http://raneksi.github.com/reittiopas/specdoc]
 
 == DESCRIPTION:
 
@@ -27,11 +28,27 @@ Search for a location by KKJ[http://fi.wikipedia.org/wiki/Kartastokoordinaattij%
   puts "#{location}, #{location.city}"
 Otakaari 9, Espoo
 
+== INSTALLATION:
+
+  gem install reittiopas
+
+or for the latest git:
+
+  git clone git://github.com/raneksi/reittiopas.git
+  cd reittiopas
+  rake newb
+  rake install_gem
+
 == REQUIREMENTS:
 
 * Nokogiri[http://nokogiri.org/]
 * Addressable[http://github.com/sporkmonger/addressable]
 
+== TODO:
+
+* Support for determining the closest stop within radius
+* Routing
+
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -2,33 +2,26 @@ require 'rubygems'
 gem 'hoe', '>= 2.1.0'
 require 'hoe'
 require 'fileutils'
-require './lib/reittiopas'
 
 Hoe.plugin :newgem
 
 $hoe = Hoe.spec 'reittiopas' do
   developer 'Raine Virta', 'raine.virta@gmail.com'
-  self.rubyforge_name   = self.name
+  self.rubyforge_name = self.name
 
   %w{ addressable nokogiri }.each do |dep|
-    self.extra_dev_deps << [dep, '>= 0']
+    self.extra_deps << [dep, '>= 0']
   end
 
   self.url              = "http://github.com/raneksi/reittiopas"
-  self.extra_dev_deps   = [['webmock', ">= 0"]]
+  self.extra_dev_deps   = [
+    ['webmock', ">= 0.9.1"],
+    ['rspec', ">= 0"],
+    ['darkfish-rdoc', ">= 0"]
+  ]
   self.readme_file      = "README.rdoc"
   self.extra_rdoc_files = FileList['*.rdoc']
 end
 
 require 'newgem/tasks'
 Dir['tasks/**/*.rake'].each { |t| load t }
-
-# remove_task :default
-# task :default => [:spec, :features]
-
-require 'gokdok'
-Gokdok::Dokker.new do |gd|
-  gd.repo_url  = "git@github.com:raneksi/reittiopas.git"
-  gd.rdoc_task = :docs
-  gd.doc_home  = 'doc'
-end

data/lib/reittiopas.rb

@@ -1,13 +1,13 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-require 'rubygems'
 require 'uri'
 require 'cgi'
 require 'net/http'
 require 'nokogiri'
 require 'addressable/uri'
 
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'reittiopas/exceptions'
 require 'reittiopas/utils'
 require 'reittiopas/coordinates'
 require 'reittiopas/location'
@@ -17,7 +17,7 @@ require 'reittiopas/http'
 
 class Reittiopas
   # The version of Reittiopas you are using.
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end
 
 # Shorter way for Reittiopas instance creation.

data/lib/reittiopas/exceptions.rb

@@ -0,0 +1,4 @@
+class Reittiopas
+  class AccessError < ::StandardError
+  end
+end

data/lib/reittiopas/geocoding.rb

@@ -6,9 +6,11 @@ module Geocoding
 
   # Send a geocode location query to the API.
   # Both geocoding, and reverse geocoding data is accessed through this method.
-  #
   # Returns results as an array containing Reittiopas::Location objects.
   #
+  # [opts] Either a keyword string, or a hash containing KKJ coordinates
+  #        presented as rectangular grid coordinates.
+  #
   # === Examples:
   # * Search for location by keyword _tee_.
   #  reittiopas.location('tee')
@@ -20,6 +22,7 @@ module Geocoding
     params = if opts.is_a? String
       {:key => opts}
     elsif opts.is_a? Hash
+      opts.assert_required_and_valid_keys :x, :y
       opts
     end
 
@@ -28,6 +31,8 @@ module Geocoding
 
 private
   # Parse XML received from a geocoding API query.
+  #
+  # [xml] Raw XML received from API.
   def parse(xml, opts)
     doc = Nokogiri::XML(xml)
 

data/lib/reittiopas/http.rb

@@ -18,7 +18,8 @@ class HTTP
 
   # Create a new Reittiopas::HTTP object.
   #
-  # +account+ should be a hash containing +:username+ and +:password+.
+  # [account] A hash containing the keys +:username+ and +:password+ with
+  #           their respective values.
   def initialize(account)
     @api_uri = Addressable::URI.parse(API_BASE_URI)
     @api_uri.query_values = {:user => account[:username], :pass => account[:password]}
@@ -27,14 +28,23 @@ class HTTP
   # Send a GET request to the API with account details and +opts+ as query
   # parameters.
   #
-  # * +opts+ — A hash containing query parameters. Values are automatically
-  # encoded by Addressable::URI.
+  # [opts] A hash containing query parameters. Values are automatically
+  #        encoded by Addressable::URI.
   def get(opts)
     raise ArgumentError if opts.empty?
     uri = @api_uri.dup
     opts.merge!(opts){ |k,ov| ov.to_s } # Coordinates to string
     uri.query_values = uri.query_values.merge(opts)
-    return Net::HTTP.get(uri)
+
+    # TODO ugly workaround until addressable's author updates the game
+    body = Net::HTTP.get(URI.parse(uri.to_s))
+
+    # API responses with 200 OK in case of invalid account, so...
+    if body =~ /No rights to access API./
+      raise AccessError, 'Most likely due to invalid account details'
+    end
+
+    body
   end
 end
 end

data/lib/reittiopas/reittiopas.rb

@@ -3,13 +3,15 @@
 #
 class Reittiopas
   include Geocoding
-  
+
   # Instantiate a Reittiopas object.
   #
-  # +account+ should be a hash containing +:username+ and +:password+.
+  # [account] A hash containing the keys +:username+ and +:password+ with
+  #           their respective values.
   #
   #   Reittiopas.new(:username => 'exampleuser', :password => 'lolcat')
   def initialize(account)
+    account.assert_required_and_valid_keys :username, :password
     @http = Reittiopas::HTTP.new(account)
   end
 end

data/lib/reittiopas/utils.rb

@@ -9,3 +9,34 @@ class Element
 end
 end
 end
+
+class Hash
+  # Raise ArgumentError if the hash has keys other than +keys+.
+  def assert_valid_keys(*valid_keys)
+    unknown_keys = keys - [valid_keys].flatten
+    raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
+  end
+
+  # Raise ArgumentError if the hash is missing required keys.
+  def assert_required_keys(*required_keys)
+    missing_keys = [required_keys].flatten - keys
+    raise(ArgumentError, "Missing required key(s) in the argument hash: #{missing_keys.join(", ")}") unless missing_keys.empty?
+  end
+
+  # Both assert_valid_keys and assert_required_keys combined.
+  #
+  # Expect certain keys and none else.
+  def assert_required_and_valid_keys(*keys)
+    assert_valid_keys(keys)
+    assert_required_keys(keys)
+  end
+
+  def assert_valid_values(hash)
+    self.each do |key, value|
+      next unless hash[key]
+      unless value.to_s =~ hash[key]
+        raise(ArgumentError, "Invalid value for #{key}: #{value.inspect}")
+      end
+    end
+  end
+end

data/spec/fixtures/no_access

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Wed, 07 Apr 2010 13:33:08 GMT
+Server: Apache/2
+X-Powered-By: PHP/5.2.6-1+lenny8
+Content-Length: 27
+Content-Type: text/html; charset=iso-8859-1
+
+No rights to access API.<P>

data/spec/reittiopas_spec.rb

@@ -15,6 +15,20 @@ end
 describe Reittiopas do
   before { @account = {:username => 'foo', :password => 'bar'} }
 
+  context "when initializing with missing arguments" do
+    it "should raise ArgumentError if password is missing" do
+      lambda do
+        Reittiopas.new(:username => 'foo')
+      end.should raise_error ArgumentError
+    end
+
+    it "should raise ArgumentError if username is missing" do
+      lambda do
+        Reittiopas.new(:password => 'foo')
+      end.should raise_error ArgumentError
+    end
+  end
+
   context "when initialized with an account" do
     subject { Reittiopas.new(@account) }
 
@@ -86,6 +100,17 @@ describe Reittiopas::HTTP do
   end
 
   describe "#get" do
+    context "when making a request with invalid account details" do
+      before do
+        no_access_response = File.open(File.dirname(__FILE__) + '/fixtures/no_access')
+        stub_request(:get, Regexp.new(BASE_URI)).to_return(no_access_response)
+      end
+
+      it "should raise AccessError" do
+        lambda { @http.get(:foo => 'bar') }.should raise_error(Reittiopas::AccessError)
+      end
+    end
+
     context "with empty hash as argument" do
       it { lambda { @http.get({}) }.should raise_error(ArgumentError) }
     end
@@ -240,6 +265,38 @@ describe Reittiopas::Location::Coordinates::WGS do
 
   it { should respond_to :latitude }
   it { should respond_to :longitude }
-  
+
   it { subject.to_s.should eql '60.23245, 24.74568' }
 end
+
+describe Hash do
+  describe "#assert_valid_keys" do
+    context "when invalid keys are found" do
+      it "should raise ArgumentError when invalid keys are found" do
+        lambda do
+          { :name => "Rob", :years => "28" }.assert_valid_keys :name, :age
+        end.should raise_error(ArgumentError, "Unknown key(s): years")
+      end
+    end
+  end
+
+  describe "#assert_required_keys" do
+    context "when required keys are missing" do
+      it "should raise ArgumentError" do
+        lambda do
+          { :name => "Rob", :years => "28" }.assert_required_keys :weight
+        end.should raise_error(ArgumentError, "Missing required key(s) in the argument hash: weight")
+      end
+    end
+  end
+
+  describe "#assert_required_and_valid_keys" do
+    context "when invalid keys are found and required keys are missing" do
+      it "should raise ArgumentError" do
+        lambda do
+          { :name => "Rob"}.assert_required_and_valid_keys :weight
+        end.should raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -16,4 +16,4 @@ BASE_URI = "http://api.reittiopas.fi/public-ytv/fi/api/"
 
 def parse_elem(xml)
   Nokogiri::XML(xml).children[0]
-end
+end

data/tasks/rdoc.rake

@@ -0,0 +1,8 @@
+namespace :docs do
+  desc "Publish rdoc to Github pages"
+  task :publish => "docs" do
+    sh 'cp doc/README_rdoc.html doc/index.html'
+    sh 'cp -R doc/* .gh_pages/'
+    sh 'cd .gh_pages; git add .; git commit -m "Update docs"; git push origin gh-pages'
+  end
+end

data/tasks/rspec.rake

@@ -29,10 +29,22 @@ namespace :spec do
       '--exclude', 'spec'
     ]
   end
-  
+
   desc "Browse the code coverage report."
   task :browse => "spec:rcov" do
     require "launchy"
     Launchy::Browser.run("coverage/index.html")
   end
-end
+
+  desc "Generate HTML Specdocs for all specs"
+  Spec::Rake::SpecTask.new(:specdoc) do |t|
+    specdoc_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'specdoc'))
+    Dir.mkdir(specdoc_path) if !File.exist?(specdoc_path)
+
+    output_file = File.join(specdoc_path, 'index.html')
+    t.libs = %w[lib spec]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ["--format", "\"html:#{output_file}\"", "--diff"]
+    t.fail_on_error = false
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Raine Virta
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-05 00:00:00 +03:00
+date: 2010-04-22 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: webmock
+  name: addressable
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
@@ -27,12 +27,62 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: nokogiri
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: darkfish-rdoc
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -42,7 +92,7 @@ dependencies:
         - 0
         version: 2.6.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id006
 description: |-
   Reittiopas is a Ruby library for accessing the {Reittiopas Developer API}[http://developer.reittiopas.fi/pages/fi/reittiopas-api.php].
   
@@ -62,9 +112,9 @@ files:
 - Manifest.txt
 - README.rdoc
 - Rakefile
-- deps.rip
 - lib/reittiopas.rb
 - lib/reittiopas/coordinates.rb
+- lib/reittiopas/exceptions.rb
 - lib/reittiopas/geocoding.rb
 - lib/reittiopas/http.rb
 - lib/reittiopas/location.rb
@@ -74,10 +124,12 @@ files:
 - script/destroy
 - script/generate
 - spec/fixtures/key.xml
+- spec/fixtures/no_access
 - spec/fixtures/reverse_geocoding.xml
 - spec/reittiopas_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- tasks/rdoc.rake
 - tasks/rspec.rake
 has_rdoc: true
 homepage: http://github.com/raneksi/reittiopas

data/deps.rip

@@ -1 +0,0 @@
-http://github.com/sporkmonger/addressable.git