coordsafe_api 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTIwYWU3NGY4OGQ0NWY3YzAxOGQ0MmQ4NmY4Y2I3OWE2ZmRhZjczZQ==
+  data.tar.gz: !binary |-
+    MzlkZWEyNGViNDc3ZDNhOTliZjQ2MmE1OWU2OWNmZmEyYjIwNjYxMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NmYxOGIxYjhjMmFhYmQ5ZjNlNDI1ZGJlOWRjOGFjMDVhMTI2OGY5NDdkYzUw
+    ZDMyZjQ4YjIxYjhiNjA2NWYzYWUxMWYyN2Q3YThiYjYxYjc5NjA5MTk3ZTQ4
+    NTY2NjdiYmIyZjdiODhkMDkyZjZhMzI4YWQzZDdmOTNlM2EyNWU=
+  data.tar.gz: !binary |-
+    Y2Y1NmRhZDQ4MGQ0MTdkYWNlZmZhYTJiYmU4OTM0MWEzODM3NDExOTAyNGRh
+    ZDM3ZDQ5ZDk2MTM1Nzg3N2Y4MDJmMjMzN2Y0MmFiNjE3MWNlYWQ1OTE1ZTE3
+    OTgyZmRkYzg1ZGIwMzIxMGVmOGQ2Yjk4MjFkYzA3ZDY4YjQ0ZWU=

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/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'coveralls', require: false
+
+# Specify your gem's dependencies in coordsafe_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    coordsafe_api (0.1.0)
+      httparty
+      yajl-ruby
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    crack (0.4.0)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.4)
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    mime-types (1.23)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    safe_yaml (0.9.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.18.1)
+    webmock (1.13.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  coordsafe_api!
+  coveralls
+  rake
+  rspec (~> 2.6)
+  webmock

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vincent Paca
+
+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,7 @@
+Coordsafe Api
+=============
+[![Build Status](https://travis-ci.org/EdeyaLabs/coordsafe_api.png?branch=master)](https://travis-ci.org/EdeyaLabs/coordsafe_api)
+[![Code Climate](https://codeclimate.com/github/EdeyaLabs/coordsafe_api.png)](https://codeclimate.com/github/EdeyaLabs/coordsafe_api)
+[![Coverage Status](https://coveralls.io/repos/EdeyaLabs/coordsafe_api/badge.png?branch=master)](https://coveralls.io/r/EdeyaLabs/coordsafe_api?branch=master)
+
+Ruby wrapper for the Coordsafe locator API

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake"
+require "rspec"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |s|
+  s.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/coordsafe_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coordsafe_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "coordsafe_api"
+  spec.version       = CoordsafeApi::VERSION
+  spec.authors       = ["Vincent Paca"]
+  spec.email         = ["vincent.paca@gmail.com"]
+  spec.description   = %q{A ruby wrapper for the Coordsafe locator API}
+  spec.summary       = %q{Wrapper for the Coordsafe API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "httparty"
+  spec.add_dependency "yajl-ruby"
+end

data/lib/coordsafe_api/configuration.rb

@@ -0,0 +1,43 @@
+module CoordsafeApi
+  module Configuration
+    VALID_CONNECTION_KEYS = [:locator_endpoint, :history_endpoint, :single_history_endpoint, :user_agent, :method].freeze
+    VALID_OPTIONS_KEYS    = [:secret, :company_name, :format].freeze
+    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+    DEFAULT_LOCATOR_ENDPOINT        = "http://www.coordsafe.com.sg/CoordSafePortalApp/locators/lc/company"
+    DEFAULT_HISTORY_ENDPOINT        = "http://www.coordsafe.com.sg/CoordSafePortalApp/locators/lc/history"
+    DEFAULT_SINGLE_HISTORY_ENDPOINT = "http://www.coordsafe.com.sg/CoordSafePortalApp/locators/lc/location"
+    DEFAULT_METHOD                  = :get
+    DEFAULT_USER_AGENT              = "CoordsafeApi Ruby Gem #{CoordsafeApi::VERSION}".freeze
+
+    DEFAULT_KEY          = nil
+    DEFAULT_COMPANY_NAME = nil
+    DEFAULT_FORMAT       = :json
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset
+      self.locator_endpoint        = DEFAULT_LOCATOR_ENDPOINT
+      self.history_endpoint        = DEFAULT_HISTORY_ENDPOINT
+      self.single_history_endpoint = DEFAULT_SINGLE_HISTORY_ENDPOINT
+      self.method                  = DEFAULT_METHOD
+      self.user_agent              = DEFAULT_USER_AGENT
+
+      self.secret       = DEFAULT_KEY
+      self.company_name = DEFAULT_COMPANY_NAME
+      self.format       = DEFAULT_FORMAT
+    end
+
+    def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+  end
+end

data/lib/coordsafe_api/locator.rb

@@ -0,0 +1,40 @@
+module CoordsafeApi
+  class Locator
+    include HTTParty
+
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+
+    def initialize(options={})
+      merged_options = CoordsafeApi.options.merge(options)
+
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    def locate
+      response = self.class.get("#{locator_endpoint}/#{URI.escape(company_name)}?key=#{secret}")
+      Response.new(response)
+    end
+
+    # opts: locator_id, date_from, date_to
+    # If only date_from exists,
+    def locate_history(locator_id, date_from, date_to=nil)
+      if date_to.nil?
+        response = self.class.get("#{single_history_endpoint}/#{locator_id}/#{Locator.parameterize(date_from)}?key=#{secret}")
+        Response.new(response)
+      else
+        response = self.class.get("#{history_endpoint}/#{locator_id}/#{Locator.parameterize(date_from, date_to)}?key=#{secret}")
+        Response.new(response)
+      end
+    end
+
+    def self.parameterize(date_from, date_to=nil)
+      unless date_to.nil?
+        URI.escape("#{date_from.strftime("%m-%d-%Y %H:%M")},#{date_to.strftime("%m-%d-%Y %H:%M")}")
+      else
+        URI.escape(date_from.strftime("%m-%d-%Y %H:%M"))
+      end
+    end
+  end
+end

data/lib/coordsafe_api/response.rb

@@ -0,0 +1,22 @@
+module CoordsafeApi
+  class Response
+    attr_accessor :success, :body
+
+    def initialize(request)
+      @status, @body = request.response, request.response.body
+    end
+
+    def success
+      if @status.class == Net::HTTPOK
+        true
+      else
+        false
+      end
+    end
+
+    def body
+      JSON.parse @body
+    end
+  end
+end
+

data/lib/coordsafe_api/version.rb

@@ -0,0 +1,3 @@
+module CoordsafeApi
+  VERSION = "0.1.0"
+end

data/lib/coordsafe_api.rb

@@ -0,0 +1,13 @@
+require 'httparty'
+require 'json'
+
+require "coordsafe_api/version"
+require "coordsafe_api/configuration"
+require "coordsafe_api/locator"
+require "coordsafe_api/response"
+
+module CoordsafeApi
+  extend Configuration
+end
+
+

data/spec/coordsafe_api/configuration_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe CoordsafeApi::Configuration do
+  describe "when setting the configuration" do
+    after do
+      CoordsafeApi.reset
+    end
+
+    it "should set the configuration keys" do
+      CoordsafeApi.configure do |config|
+        config.secret = "qwerty"
+        config.company_name = "EdeyaLabs"
+      end
+
+      CoordsafeApi.secret.should eq "qwerty"
+      CoordsafeApi.company_name.should eq "EdeyaLabs"
+    end
+  end
+end

data/spec/coordsafe_api/locator_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+
+describe CoordsafeApi::Locator do
+  context "on utilizing the API" do
+    before(:each) do
+      @api = CoordsafeApi::Locator.new({:company_name => "Sypher Labs Pte. Ltd.", :key => "test-1234qwer"})
+      stub_request(:get, "http://www.coordsafe.com.sg/CoordSafePortalApp/locators/lc/company/Sypher%20Labs%20Pte.%20Ltd.?key=").to_return(
+        :body => '[ {"location":null,"imeiCode":"353301057336682","gpsLocation":{"time":0,"accuracy":0.0,"altitude":0.0,"bearing":0.0,
+          "distance":0.0,"hasAccuracy":false,"hasAltitude":false,"hasBearing":false,"hasSpeed":false,"initialBearing":0.0,"latitude":1.5296516666666666,
+          "longitude":103.77401,"speed":0.0},"deviceStatus":{"isGpsOn":false,"imei":"","isGsmOn":false,"networkAvailability":0,"ip":"","batteryLeft":0},
+          "create":false,"assignedTo":"Sypher Labs Pte. Ltd.","id":35,"type":"CS","status":null,"madeBy":null,"madeDate":1423065600000,"model":"BBT-01",
+          "label":"PDN399","lastLocationUpdate":1373096366341,"ownerId":"CS","lastStatusUpdate":1369535434914} ]',
+        :headers => { "Content-Type" => 'application/json', "Transfer-Encoding" => 'chunked' })
+      stub_request(:get, "http://www.coordsafe.com.sg/CoordSafePortalApp/locators/lc/location/18/01-27-2013%2009:30?key=").to_return(
+        :body => '[ {"id":209588,"accuracy":0.0,"altitude":0.0,"bearing":164.39999389648438,"distance":0.0,"speed":65.5,"lat":1.3918833333333334,
+        "lng":103.75420666666668,"location_time":1359248454818,"locator_id":18},{"id":209589,"accuracy":0.0,"altitude":0.0,"bearing":165.35000610351562,
+        "distance":0.0,"speed":64.5999984741211,"lat":1.3910783333333332,"lng":103.75441166666666,"location_time":1359248454862,"locator_id":18} ]',
+        :content_type => 'application/json')
+      stub_request(:get, "http://www.coordsafe.com.sg/CoordSafePortalApp/locators/lc/history/18/01-27-2013%2009:00,01-27-2013%2010:00?key=").to_return(
+        :body => ' {"id":209869,"accuracy":0.0,"altitude":0.0,"bearing":178.89999389648438,"distance":0.0,"speed":37.900001525878906,
+        "lat":1.3253249999999999,"lng":103.76431833333332,"location_time":1359250196802,"locator_id":18}',
+        :content_type => 'application/json')
+    end
+
+    it "should respond with the CoordsafeApi::Response object on #locate" do
+      request = @api.locate
+      request.class.should eq(CoordsafeApi::Response)
+    end
+
+    it "should respond with an Array of JSON on #locate" do
+      request = @api.locate
+      results = request.body
+      results.class.should eq(Array)
+      results.each do |r|
+        r.class.should eq(Hash)
+      end
+    end
+
+    it "should return true for success" do
+      request = @api.locate
+      request.success.should be_true
+    end
+
+    it "should respond with the CoordsafeApi::Response object on #locate_history with date_from" do
+      request = @api.locate_history(18, DateTime.parse("2013-01-27 09:30"))
+      request.class.should eq(CoordsafeApi::Response)
+    end
+
+    it "should respond with JSON on #locate_history with date_from" do
+      request = @api.locate_history(18, DateTime.parse("2013-01-27 09:30"))
+      results = request.body
+      results.class.should eq(Array)
+      results.each do |r|
+        r.class.should eq(Hash)
+      end
+    end
+
+    it "should return true for success" do
+      request = @api.locate_history(18, DateTime.parse("2013-01-27 09:30"))
+      request.success.should be_true
+    end
+
+    it "should respond with the CoordsafeApi::Response object on #locate_history with date_from and date_to" do
+      request = @api.locate_history(18, DateTime.parse("2013-01-27 09:00"), DateTime.parse("2013-01-27 10:00"))
+      request.class.should eq(CoordsafeApi::Response)
+    end
+
+    it "should respond with JSON on #locate_history with date_from and date_to" do
+      request = @api.locate_history(18, DateTime.parse("2013-01-27 09:00"), DateTime.parse("2013-01-27 10:00"))
+      results = request.body
+      results.class.should eq(Hash)
+    end
+
+    it "should return true for success" do
+      request = @api.locate_history(18, DateTime.parse("2013-01-27 09:00"), DateTime.parse("2013-01-27 10:00"))
+      request.success.should be_true
+    end
+
+
+    it "should parameterize date_from on #paramemterize" do
+      CoordsafeApi::Locator.parameterize(DateTime.parse("2013-07-06 9:30")).should eq("07-06-2013%2009:30")
+    end
+
+    it "should parameterize dates on #parameterize" do
+      CoordsafeApi::Locator.parameterize(DateTime.parse("2013-07-06 9:30"), DateTime.parse("2013-07-08 5:00")).should eq("07-06-2013%2009:30,07-08-2013%2005:00")
+    end
+  end
+
+  context "on configuration" do
+    before do
+      @keys = CoordsafeApi::Configuration::VALID_CONFIG_KEYS
+    end
+
+    describe "with module configuration" do
+      before do
+        CoordsafeApi.configure do |config|
+          @keys.each do |key|
+            config.send("#{key}=", key)
+          end
+        end
+      end
+
+      after do
+        CoordsafeApi.reset
+      end
+
+      it "should inherit module configuration" do
+        api = CoordsafeApi::Locator.new
+        @keys.each do |key|
+          api.send(key).should eq(key)
+        end
+      end
+
+      describe "with class configuration" do
+        before do
+          @config = {
+            :secret                  => "qwerty",
+            :company_name            => "qwerty",
+            :format                  => "test",
+            :locator_endpoint        => "test",
+            :history_endpoint        => "test",
+            :single_history_endpoint => "test",
+            :user_agent              => "qwerty",
+            :method                  => "test",
+          }
+        end
+
+        it "should ovverride module configuration" do
+          api = CoordsafeApi::Locator.new(@config)
+          @keys.each do |key|
+            api.send(key).should eq @config[key]
+          end
+        end
+
+        it "should override module configuration after" do
+          api = CoordsafeApi::Locator.new
+
+          @config.each do |key, value|
+            api.send("#{key}=", value)
+          end
+
+          @keys.each do |key|
+            api.send("#{key}").should eq @config[key]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'rspec'
+require 'coveralls'
+require 'coordsafe_api'
+require 'webmock/rspec'
+
+Coveralls.wear!

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: coordsafe_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vincent Paca
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: yajl-ruby
+  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'
+description: A ruby wrapper for the Coordsafe locator API
+email:
+- vincent.paca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- coordsafe_api.gemspec
+- lib/coordsafe_api.rb
+- lib/coordsafe_api/configuration.rb
+- lib/coordsafe_api/locator.rb
+- lib/coordsafe_api/response.rb
+- lib/coordsafe_api/version.rb
+- spec/coordsafe_api/configuration_spec.rb
+- spec/coordsafe_api/locator_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.0.3
+signing_key: 
+specification_version: 4
+summary: Wrapper for the Coordsafe API
+test_files:
+- spec/coordsafe_api/configuration_spec.rb
+- spec/coordsafe_api/locator_spec.rb
+- spec/spec_helper.rb