here_places 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Prem Pillai
+
+MIT License
+
+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,163 @@
+# HerePlaces
+A wafer-thin Ruby wrapper for accessing Nokia's Here Maps Places API.  
+Read more about the official API here: <http://developer.here.net/>
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'here_places'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install here_places
+
+* * *
+
+## Getting Started
+
+The aim of this gem is to provide a ruby wrapper around the REST APIs that **Here** provides. Read more about the APIs here: <http://developer.here.net/docs/places/topics/resources.html>
+
+To start using the APIs, register for a Nokia Developer Account <http://developer.here.net/> to get your APP\_ID and APP\_CODE
+
+* * *
+
+### Discover API 
+
+#### Searching <http://developer.here.net/docs/places/topics/resource-search.html>  
+
+The search resource represent sets of places that match a user's search term in a specific location context (such as near a given location, around a user's current position or on the currently visible map).
+
+    require 'here_places'
+    app_id = "YOUR_APP_ID"
+    app_code = "YOUR_APP_CODE"
+    data = {
+      q: 'Cafe',
+      at: '40.74917,-73.98529',
+    }
+    api = HerePlaces::Discover.new(app_id, app_code)
+    a = api.search(data)
+
+#### Exploring <http://developer.here.net/docs/places/topics/resource-explore.html>  
+
+The explore resource represent sets of popular places within a specific location context. The explore resource allows users to explore places without typing search queries. An explore resource's location context might be an explicitly given location or implicitly defined by a user's current position or the currently visible map. Optionally, the places may be restricted to a given set of categories.
+`at` and `in` parameter are mutually exclusive and can't be passed at the same time
+
+    require 'here_places'
+    app_id = "YOUR_APP_ID"
+    app_code = "YOUR_APP_CODE"
+    data = {
+      cat: 'natural-geographical',
+      at: '40.74917,-73.98529',
+    }
+    api = HerePlaces::Discover.new(app_id, app_code)
+    a = api.explore(data)
+    
+#### Here <http://developer.here.net/docs/places/topics/resource-discover-here.html>  
+
+The discover here resource represent sets of places within a specific location context. The Discover Here resource allows users to request places near to a given point, based on a location precision parameter which must be provided. If the precision is high, the places around that point are returned in order of proximity. Otherwise, a set of recommended places in the area is returned.
+
+    require 'here_places'
+    app_id = "YOUR_APP_ID"
+    app_code = "YOUR_APP_CODE"
+    data = {
+      cat: 'natural-geographical',
+      at: '40.7063,-73.9971;u=0',
+    }
+    api = HerePlaces::Discover.new(app_id, app_code)
+    a = api.here(data)
+
+* * *
+
+### Places 
+
+#### The Place Resource <http://developer.here.net/docs/places/topics/resource-discover-here.html>  
+
+The place resource represent places on earth.
+Examples for places include:
+Places of (public) interest (POI)
+Addresses of buildings (Locations)
+Named areas and regions
+Each place is referenced by an identifier, called a placeId.
+
+    require 'here_places'
+    app_id = "YOUR_APP_ID"
+    app_code = "YOUR_APP_CODE"
+    id = '840dr5rs-5c0f37fabdc643938dd4f47db00d4ae8'
+    api = HerePlaces::Place.new(app_id, app_code)
+    a = api.places(id)
+
+* * *
+        
+### Suggestions
+
+#### The Search Suggestion Resource <http://developer.here.net/docs/places/topics/resource-suggest.html>  
+
+The search suggestions resource represents lists of suggested search terms related to a given (partial) search term and location context.
+
+    require 'here_places'
+    app_id = "YOUR_APP_ID"
+    app_code = "YOUR_APP_CODE"
+    data = {
+      q: 'restaur',
+      at: '40.7063,-73.9971',
+    }
+    api = HerePlaces::Suggest.new(app_id, app_code)
+    a = api.suggest(data)
+
+* * *
+
+### Categories
+
+#### The Category Graph Resource <http://developer.here.net/docs/places/topics/resource-category-graph.html>  
+
+The category graph resource represents sets of locally relevant categories that are organized in a graph-like hierarchy. The category graph may change at any point in the future and may be different depending on the location of the request. A set of permanent, top-level, categories can be found [here](http://developer.here.net/docs/places/topics/categories.html).
+
+    require 'here_places'
+    app_id = "YOUR_APP_ID"
+    app_code = "YOUR_APP_CODE"
+    data = {
+      at: '40.7063,-73.9971',
+    }
+    api = HerePlaces::Category.new(app_id, app_code)
+    a = api.places(data)
+
+* * *
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+* * *
+
+## License
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/here_places.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'here_places/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "here_places"
+  gem.version       = HerePlaces::VERSION 
+  gem.authors       = ["Prem Pillai"]
+  gem.email         = ["prem.pillai@gmail.com"]
+  gem.description   = %q{A wafer-thin Ruby Wrapper for Nokia's Here Places API}
+  gem.summary       = %q{A wafer-thin Ruby Wrapper for Nokia's Here Places API}
+  gem.homepage      = "https://github.com/premjg/here_places"
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features|helper)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency 'rspec', '~>2.1'
+  gem.add_development_dependency 'fakeweb', '~>1.3'
+  gem.add_dependency 'faraday', '~>0.8.4'
+end

data/lib/here_places/base.rb

@@ -0,0 +1,41 @@
+module HerePlaces
+  class Base
+    @@base_url = 'http://places.nlp.nokia.com/'
+    @@api_prefix = 'places/v1'
+
+    attr_reader :conn
+
+    def initialize(app_id, app_code, log=false)
+      @app_id = app_id
+      @app_code = app_code
+      @log = log
+      setup()
+    end
+    
+    def setup
+      @conn = Faraday.new(:url => @@base_url) do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :logger if @log
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+    def api(url_fragment, data={})
+      result = @conn.get do |req|
+        req.url url_fragment
+        req.params['app_id'] = @app_id
+        req.params['app_code'] = @app_code
+        data.each do |key,value|
+          req.params[key] = value
+        end
+      end
+      
+      parsed_result = JSON.parse(result.body)
+      if parsed_result["status"]
+        raise HerePlaces::APIError.new(parsed_result), parsed_result['message']
+      else
+        parsed_result
+      end
+    end
+  end
+end

data/lib/here_places/category.rb

@@ -0,0 +1,10 @@
+module HerePlaces
+  class Category < HerePlaces::Base
+    @@resource = 'categories'
+
+    def places(data)
+      url = @@api_prefix + '/' + @@resource + '/' + 'places'
+      api(url, data)
+    end
+  end
+end

data/lib/here_places/discover.rb

@@ -0,0 +1,11 @@
+module HerePlaces
+  class Discover < HerePlaces::Base
+    @@resource = 'discover'
+    %w(search explore here).each do |meth|
+      define_method(meth) do |data|
+        url = @@api_prefix + '/' + @@resource + '/' + meth
+        api(url, data)
+      end
+    end
+  end
+end

data/lib/here_places/error.rb

@@ -0,0 +1,10 @@
+module HerePlaces
+  class APIError < StandardError
+    attr_accessor :status, :error_message
+    
+    def initialize(error)
+      self.status = error["status"].to_i rescue 500
+      self.error_message = error["error_message"] || 'Unknown Error'
+    end
+  end
+end

data/lib/here_places/place.rb

@@ -0,0 +1,10 @@
+module HerePlaces
+  class Place < HerePlaces::Base
+    @@resource = 'places'
+
+    def places(id)
+      url = @@api_prefix + '/' + @@resource + '/' + id.to_s
+      api(url)
+    end
+  end
+end

data/lib/here_places/suggest.rb

@@ -0,0 +1,10 @@
+module HerePlaces
+  class Suggest < HerePlaces::Base
+    @@resource = 'suggest'
+
+    def suggest(data)
+      url = @@api_prefix + '/' + @@resource
+      api(url, data)
+    end
+  end
+end

data/lib/here_places/version.rb

@@ -0,0 +1,3 @@
+module HerePlaces
+  VERSION = "0.0.2"
+end

data/lib/here_places.rb

@@ -0,0 +1,15 @@
+require "faraday"
+require "json"
+require_relative './here_places/base'
+require_relative './here_places/category'
+require_relative './here_places/discover'
+require_relative './here_places/error'
+require_relative './here_places/place'
+require_relative './here_places/suggest'
+
+# /discover/search?q=...&[at=...]
+# /discover/explore?[cat=...]&[(at|in)=...]
+# /discover/here?[at=...]
+# /places/{placeId}
+# /suggest?q=...&[at=...]
+# /categories/places?[at=...]

data/spec/base_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe HerePlaces::Base do
+  before(:each) do
+    @app_id = 'APP_ID'
+    @app_code = 'APP_CODE'
+  end
+
+  context "after initialize" do
+    it 'calls the setup method' do
+      HerePlaces::Base.any_instance.stub(:setup)
+      HerePlaces::Base.any_instance.should_receive(:setup)
+      @h = HerePlaces::Base.new(@app_id, @app_code)
+    end
+  end
+
+  context "the setup method" do
+    it "correctly sets up the Faraday connection object" do
+      @h = HerePlaces::Base.new(@app_id, @app_code)
+      @h.conn.should be_an_instance_of(Faraday::Connection)
+    end
+  end
+
+  context "api method" do
+    before(:each) do
+      @url_fragment = 'some/url/fragment'
+      @data = {test: 'stuff'}
+    end
+
+    after(:each) do
+      FakeWeb.clean_registry
+    end
+
+    it "correctly constructs the API URL and makes calls" do
+      @h = HerePlaces::Base.new(@app_id, @app_code)
+      FakeWeb.register_uri(:get, %r|^http:\/\/places\.nlp\.nokia\.com\/.*|, :body => {stuff: 'test'}.to_json)
+      @h.api(@url_fragment, @data)
+      @parametrized_data = URI.encode_www_form(@data)
+      FakeWeb.last_request.path.should eq("/#{@url_fragment}?app_id=#{@app_id}&app_code=#{@app_code}&#{@parametrized_data}")
+    end
+
+    it "flips out and raises error when it receives an API error" do
+      @h = HerePlaces::Base.new(@app_id, @app_code)
+      FakeWeb.register_uri(:get, %r|^http:\/\/places\.nlp\.nokia\.com\/.*|, :body => {status: 400, stuff: 'test'}.to_json)
+      expect {@h.api(@url_fragment, @data)}.to raise_error(HerePlaces::APIError)
+    end
+  end
+
+end

data/spec/category_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe HerePlaces::Category do
+  before(:each) do
+    app_id = 'APP_ID'
+    app_code = 'APP_CODE'
+    @data = {test: 'stuff'}
+    @h = HerePlaces::Category.new(app_id, app_code)
+    @h.stub!(:api)
+  end
+
+  it 'responds correctly to places method and delegates to the api call' do
+    resource_url = "#{API_PREFIX}/categories/places"
+    @h.should respond_to(:places)
+    @h.should_receive(:api).with(resource_url, @data)
+    @h.places(@data)
+  end
+end

data/spec/discover_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe HerePlaces::Discover do
+  before(:each) do
+    app_id = 'APP_ID'
+    app_code = 'APP_CODE'
+    @data = {test: 'stuff'}
+    @h = HerePlaces::Discover.new(app_id, app_code)
+    @h.stub!(:api)
+  end
+
+  %w(search explore here).each do |meth|
+    it "responds correctly to #{meth} and delegates to the api call" do
+      resource_url = "#{API_PREFIX}/discover/#{meth}"
+      @h.should respond_to(meth.to_sym)
+      @h.should_receive(:api).with(resource_url, @data)
+      @h.send(meth.to_sym, @data)
+    end
+  end
+end

data/spec/place_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe HerePlaces::Place do
+  before(:each) do
+    app_id = 'APP_ID'
+    app_code = 'APP_CODE'
+    @id = '123asdfa'
+    @h = HerePlaces::Place.new(app_id, app_code)
+    @h.stub!(:api)
+  end
+
+  it 'responds correctly to places method and delegates to the api call' do
+    resource_url = "#{API_PREFIX}/places/#{@id}"
+    @h.should respond_to(:places)
+    @h.should_receive(:api).with(resource_url)
+    @h.places(@id)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler'
+require 'rspec'
+require 'fakeweb'
+require 'here_places'
+
+BASE_URL = 'http://places.nlp.nokia.com/'
+API_PREFIX = 'places/v1'

data/spec/suggest_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe HerePlaces::Suggest do
+  before(:each) do
+    app_id = 'APP_ID'
+    app_code = 'APP_CODE'
+    @data = {test: 'stuff'}
+    @h = HerePlaces::Suggest.new(app_id, app_code)
+    @h.stub!(:api)
+  end
+
+  it 'responds correctly to suggest method and delegates to the api call' do
+    resource_url = "#{API_PREFIX}/suggest"
+    @h.should respond_to(:suggest)
+    @h.should_receive(:api).with(resource_url, @data)
+    @h.suggest(@data)
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: here_places
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Prem Pillai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+description: A wafer-thin Ruby Wrapper for Nokia's Here Places API
+email:
+- prem.pillai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- here_places.gemspec
+- lib/here_places.rb
+- lib/here_places/base.rb
+- lib/here_places/category.rb
+- lib/here_places/discover.rb
+- lib/here_places/error.rb
+- lib/here_places/place.rb
+- lib/here_places/suggest.rb
+- lib/here_places/version.rb
+- spec/base_spec.rb
+- spec/category_spec.rb
+- spec/discover_spec.rb
+- spec/place_spec.rb
+- spec/spec_helper.rb
+- spec/suggest_spec.rb
+homepage: https://github.com/premjg/here_places
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A wafer-thin Ruby Wrapper for Nokia's Here Places API
+test_files:
+- spec/base_spec.rb
+- spec/category_spec.rb
+- spec/discover_spec.rb
+- spec/place_spec.rb
+- spec/spec_helper.rb
+- spec/suggest_spec.rb
+has_rdoc: