nokia-here 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eda42a4b8b52039dea9b2525bbc804da08605b99
+  data.tar.gz: e286b6d26644a1dfd6a0b47c48ee7c4d257f4be6
+SHA512:
+  metadata.gz: 9e6761824436a6e48aa356e3ec04bfef14fd93a63266d7a843fdc639faae16a2eeaf7afa6425c8c71eceba9586a939d9663f423e976682c83599f183b0562b53
+  data.tar.gz: 37ed21803a94d30f9347d5da29c605d01513953691c0e8277808171df2fd0141d8866302bdbe8983ab2cba5b80abf5196e17c1f7437b794c6797f39a621ba0f8

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+spec/app_setup.rb

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 yunwei
+
+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,74 @@
+# Nokia::Here
+
+This is a ruby gem for Nokia here map rest api. It is still on a early developing stage. Only Routing APIs are implemented.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nokia-here'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nokia-here
+
+And then require it manually:
+
+    require 'nokia/here'
+
+## Usage
+Configuration:
+```ruby
+Nokia::Here.app_id = 'YOUR_APP_ID'
+Nokia::Here.app_code = 'YOUR_APP_CODE'
+```
+Resourses and Methods:
+
+```ruby
+# Routing API, not fully tested.
+Nokia::Here::Resource::Routing::Isoline.get options
+Nokia::Here::Resource::Routing::LinkInfo.get options
+Nokia::Here::Resource::Routing::Matrix.get options
+Nokia::Here::Resource::Routing::Route.calculate_route options
+Nokia::Here::Resource::Routing::Route.get_route options
+
+#Transit API, not tested
+Nokia::Here::Resource::Transit::Isochrone.search options
+
+#Geocoding API
+Nokia::Here::Resource::Geocoder.geocde
+Nokia::Here::Resource::Geocoder.reverse_geocde
+Nokia::Here::Resource::Geocoder.multi_reverse_geocode
+
+# Example:
+options = {
+    mode: 'fastest;car;traffic:enabled',
+    rangetype: 'time',
+    start: 'geo!-37.8089497,144.9731852',
+    range: 600,
+    departure: Time.now.xmlschema
+  }
+res = Nokia::Here::Resource::Routing::Isoline.get options
+# => returns JSON formatted string. You might wanna
+response_hash = JSON.parse(res)
+```
+
+For detailed parameters and options please refer to offical nokia here rest api documents
+
+
+## TODO
+More tests and API to be added.
+
+## Contributing
+
+Welcome to add testing or to implement other resources API.
+
+1. Fork it ( https://github.com/[my-github-username]/nokia-here/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/nokia/here.rb

@@ -0,0 +1,24 @@
+require "nokia/here/version"
+
+module Nokia
+  module Here
+    require 'rest-client'
+    require "nokia/here/resource/base"
+    #routing
+    require "nokia/here/resource/routing/base"
+    require "nokia/here/resource/routing/isoline"
+    require "nokia/here/resource/routing/link_info"
+    require "nokia/here/resource/routing/matrix"
+    require "nokia/here/resource/routing/route"
+    #geocoder
+    require "nokia/here/resource/geocoder"
+    #transit
+    require "nokia/here/resource/transit/base"
+    require 'nokia/here/resource/transit/isochrone'
+
+    class << self
+      attr_accessor :app_id, :app_code, :env
+    end
+
+  end
+end

data/lib/nokia/here/resource/base.rb

@@ -0,0 +1,52 @@
+module Nokia
+  module Here
+    module Resource
+      class Base
+
+        BASE_URL = 'https://transit.api.here.com'
+        TEST_URL = 'https://cit.transit.api.here.com'
+        PATH     = '/metarouter/rest/routeservice/v2' #default path
+
+        attr_accessor :method_name, :base_url, :test_url, :path
+
+
+        def initialize
+          @base_url    = BASE_URL
+          @test_url    = TEST_URL
+          @path        = PATH
+          @method_name = 'getroute' # getroute as default method.
+        end
+
+        def request_url(format: 'json')
+          format ||= 'json'
+          url = Nokia::Here.env == 'test' ? self.test_url : self.base_url
+          url = File.join(url, self.path , "#{self.method_name}.#{format}")
+          puts url
+          url
+        end
+
+        def prepare_the_request(options={})
+          params = options.merge(:app_id=>Nokia::Here.app_id, :app_code => Nokia::Here.app_code)
+        end
+
+        def get(options={})
+          res = RestClient.get(self.request_url(format: options[:format]), params: self.prepare_the_request(options))
+        end
+
+        def self.get(options={})
+          self.new.get(options)
+        end
+
+        # direct call to instance methods as class methods.
+        def self.method_missing(method_sym, *arg, &block)
+          if self.instance_methods.include?(method_sym)
+            self.new.send(method_sym, *arg, &block)
+          else
+            super
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/nokia/here/resource/geocoder.rb

@@ -0,0 +1,45 @@
+module Nokia
+  module Here
+    module Resource
+      class Geocoder < Nokia::Here::Resource::Base
+
+        BASE_URL = 'http://geocoder.api.here.com'
+        TEST_URL = 'http://geocoder.cit.api.here.com'
+        PATH     = '/6.2/'
+
+        attr_accessor :method_name, :base_url, :test_url, :path
+
+
+        def initialize
+          @base_url    = BASE_URL
+          @test_url    = TEST_URL
+          @path        = PATH
+          @method_name = 'geocode'
+        end
+
+        def geocode(options={})
+          @method_name = 'geocode'
+          get(options)
+        end
+
+        def search(options={})
+          @method_name = 'search'
+          get(options)
+        end
+
+        def reverse_geocode(options={})
+          @base_url = 'http://reverse.geocoder.api.here.com'
+          @test_url = 'http://reverse.geocoder.cit.api.here.com'
+          @method_name = 'reversegeocode'
+          get(options)
+        end
+
+        def multi_reverse_geocode(options={})
+          @base_url = 'http://reverse.geocoder.api.here.com'
+          @test_url = 'http://reverse.geocoder.cit.api.here.com'
+          @method_name = 'multi-reversegeocode'
+        end
+      end
+    end
+  end
+end

data/lib/nokia/here/resource/routing/base.rb

@@ -0,0 +1,25 @@
+module Nokia
+  module Here
+    module Resource
+      module Routing
+        class Base < Nokia::Here::Resource::Base
+
+          BASE_URL = 'http://route.api.here.com'
+          TEST_URL = 'http://route.cit.api.here.com'
+          PATH     = '/routing/7.2/'
+
+          attr_accessor :method_name, :base_url, :test_url, :path
+
+
+          def initialize
+            @base_url    = BASE_URL
+            @test_url    = TEST_URL
+            @path        = PATH
+            @method_name = 'getroute' # getroute as default method.
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nokia/here/resource/routing/isoline.rb

@@ -0,0 +1,25 @@
+module Nokia
+  module Here
+    module Resource
+      module Routing
+        class Isoline < Base
+
+          def initialize
+            super()
+            @base_url    = 'http://isoline.route.api.here.com'
+            @test_url    = 'http://isoline.route.cit.api.here.com'
+            @method_name = 'calculateisoline'
+          end
+
+          def get(options={})
+            destination = options[:destination]
+            start       = options[:start]
+            raise "One of destination or start must be supplied" unless destination or start
+            super(options)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nokia/here/resource/routing/link_info.rb

@@ -0,0 +1,22 @@
+module Nokia
+  module Here
+    module Resource
+      module Routing
+        class LinkInfo < Base
+
+          def initialize
+            super()
+            @method_name = 'getlinkinfo'
+          end
+
+          def get(options={})
+            raise ":linkids is required" unless options[:linkids]
+            raise "One of :quadKey or :tmcCodes is required" unless options[:quadKey] or options[:tmcCodes]
+            super(options)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nokia/here/resource/routing/matrix.rb

@@ -0,0 +1,18 @@
+module Nokia
+  module Here
+    module Resource
+      module Routing
+        class Matrix < Base
+
+          def initialize
+            super()
+            @method_name = 'calculatematrix'
+            @base_url    = 'http://matrix.route.api.here.com'
+            @test_url    = 'http://matrix.route.cit.api.here.com'
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nokia/here/resource/routing/route.rb

@@ -0,0 +1,30 @@
+module Nokia
+  module Here
+    module Resource
+      module Routing
+        class Route < Base
+
+          def initialize
+            super()
+            @method_name = 'getroute'
+          end
+
+          def calculate_route(options={})
+            @method_name = 'calculateroute'
+            self.get(options)
+          end
+
+          def get_route(options={})
+            @method_name = 'getroute'
+            self.get(options)
+          end
+
+          def get(options={})
+            super(options)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nokia/here/resource/transit/base.rb

@@ -0,0 +1,11 @@
+module Nokia
+  module Here
+    module Resource
+      module Transit
+        class Base < Nokia::Here::Resource::Base
+
+        end
+      end
+    end
+  end
+end

data/lib/nokia/here/resource/transit/isochrone.rb

@@ -0,0 +1,26 @@
+module Nokia
+  module Here
+    module Resource
+      module Transit
+        class Isochrone < Base
+
+          def initialize
+            super()
+            @path        = '/isochrone/v1'
+          end
+
+          def search(options={})
+            @method_name = 'search'
+            raise ":time, :x and :y are required" unless options[:time] and options[:x] and options[:y]
+            self.get(options)
+          end
+
+          def self.search(options={})
+            self.new.search(options)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nokia/here/version.rb

@@ -0,0 +1,5 @@
+module Nokia
+  module Here
+    VERSION = "0.0.1"
+  end
+end

data/nokia-here.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nokia/here/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nokia-here"
+  spec.version       = Nokia::Here::VERSION
+  spec.authors       = ["yunwei"]
+  spec.email         = ["stillwyw@gmail.com"]
+  spec.summary       = %q{A gem for Nokia Here map REST api.}
+  spec.description   = %q{Nokia Here map REST api.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rest-client'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/geocoder_spec.rb

@@ -0,0 +1,27 @@
+require './lib/nokia/here'
+require './spec/app_setup'
+RSpec.describe Nokia::Here::Resource::Geocoder do
+
+
+
+  describe "geocode an address" do
+    it "Should get a invaild isochrone search respond 403" do
+      options = {
+        searchtext: '425 W Randolph Street, Chicago',
+        gen: 9
+      }
+      res = Nokia::Here::Resource::Geocoder.geocode options
+    end
+  end
+
+  describe "reverse geocode an point" do
+    it "Should get a invaild isochrone search respond 403" do
+      options = {
+        prox: '50.112,8.683,100',
+        mode: 'retrieveAddresses',
+        gen: 9
+      }
+      res = Nokia::Here::Resource::Geocoder.reverse_geocode options
+    end
+  end
+end

data/spec/isochrone_spec.rb

@@ -0,0 +1,16 @@
+require './lib/nokia/here'
+require './spec/app_setup'
+RSpec.describe Nokia::Here::Resource::Transit::Isochrone do
+
+  describe "search isochrone" do
+    it "Should get a invaild isochrone search respond 403" do
+      options = {
+        time: '2015-12-16T06:36:40',
+        x: 144.9731852,
+        y: -37.8089497
+      }
+      puts Nokia::Here::Resource::Transit::Isochrone.search options
+    end
+
+  end
+end

data/spec/isoline_spec.rb

@@ -0,0 +1,34 @@
+require './lib/nokia/here'
+require './spec/app_setup'
+RSpec.describe Nokia::Here::Resource::Routing::Isoline do
+  
+  describe "get isoline" do
+    it "Should get a vaild isoline json" do
+      options = {
+        mode: 'fastest;car;traffic:enabled',
+        rangetype: 'time',
+        start: 'geo!-37.8089497,144.9731852',
+        range: 600,
+        departure: Time.now.xmlschema
+      }
+
+      res = Nokia::Here::Resource::Routing::Isoline.get options
+
+      expect(res.code).to eq(200)
+    end
+
+    it "Should ask for at least a start or a destination" do
+      options = {
+        mode: 'fastest;car;traffic:enabled',
+        rangetype: 'time',
+        # start: 'geo!-37.8089497,144.9731852',
+        range: 600,
+        departure: Time.now.xmlschema
+      }
+
+      expect{Nokia::Here::Resource::Routing::Isoline.get options}.to raise_error(RuntimeError)
+
+
+    end
+  end
+end

data/spec/matrix_spec.rb

@@ -0,0 +1,20 @@
+require './lib/nokia/here'
+require './spec/app_setup'
+RSpec.describe Nokia::Here::Resource::Routing::Isoline do
+
+  describe "get isoline" do
+    it "Should get a vaild isoline json" do
+      options = {
+        mode: 'fastest;car;traffic:enabled',
+        rangetype: 'time',
+        start: 'geo!-37.8089497,144.9731852',
+        range: 600,
+        departure: Time.now.xmlschema
+      }
+
+      res = Nokia::Here::Resource::Routing::Isoline.get options
+
+      expect(res.code).to eq(200)
+    end
+  end
+end

data/spec/route_spec.rb

@@ -0,0 +1,19 @@
+require './lib/nokia/here'
+require './spec/app_setup'
+RSpec.describe Nokia::Here::Resource::Routing::Isoline do
+
+  describe "get isoline" do
+    it "Should get a vaild isoline json" do
+      options = {
+        waypoint0: 'geo!51.512,-0.111',
+        waypoint1: 'geo!51.519,-0.074',
+        departure: '2016-01-04T17:00:00+02',
+        mode: 'fastest;publicTransportTimeTable'
+      }
+
+      res = Nokia::Here::Resource::Routing::Route.calculate_route options
+
+      expect(res.code).to eq(200)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: nokia-here
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- yunwei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: Nokia Here map REST api.
+email:
+- stillwyw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nokia/here.rb
+- lib/nokia/here/resource/base.rb
+- lib/nokia/here/resource/geocoder.rb
+- lib/nokia/here/resource/routing/base.rb
+- lib/nokia/here/resource/routing/isoline.rb
+- lib/nokia/here/resource/routing/link_info.rb
+- lib/nokia/here/resource/routing/matrix.rb
+- lib/nokia/here/resource/routing/route.rb
+- lib/nokia/here/resource/transit/base.rb
+- lib/nokia/here/resource/transit/isochrone.rb
+- lib/nokia/here/version.rb
+- nokia-here.gemspec
+- spec/geocoder_spec.rb
+- spec/isochrone_spec.rb
+- spec/isoline_spec.rb
+- spec/matrix_spec.rb
+- spec/route_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A gem for Nokia Here map REST api.
+test_files:
+- spec/geocoder_spec.rb
+- spec/isochrone_spec.rb
+- spec/isoline_spec.rb
+- spec/matrix_spec.rb
+- spec/route_spec.rb
+- spec/spec_helper.rb