coordsafe_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTIwYWU3NGY4OGQ0NWY3YzAxOGQ0MmQ4NmY4Y2I3OWE2ZmRhZjczZQ==
+    NWM0ZDIyZTk4MWU4YzIwZTJkMzVjMDY5NmNjNGEzZWRkYzM4ODQwMg==
   data.tar.gz: !binary |-
-    MzlkZWEyNGViNDc3ZDNhOTliZjQ2MmE1OWU2OWNmZmEyYjIwNjYxMw==
+    NDZhZTI3MTA2ZWM0NjY5ZTY5YzUxZDYwY2I5ZDRmZDkzY2FkNGM4Yg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NmYxOGIxYjhjMmFhYmQ5ZjNlNDI1ZGJlOWRjOGFjMDVhMTI2OGY5NDdkYzUw
-    ZDMyZjQ4YjIxYjhiNjA2NWYzYWUxMWYyN2Q3YThiYjYxYjc5NjA5MTk3ZTQ4
-    NTY2NjdiYmIyZjdiODhkMDkyZjZhMzI4YWQzZDdmOTNlM2EyNWU=
+    MGFkYWM3MWFiOTQ0YTdkZGNjMTRjN2VmMWM2ODE4OTZlN2RhMmI5ZjMxNzRk
+    Njg5ZWJjN2FhNWQ0NzVhMjQ5MWQ2MTYwNWY5OWZmNDkwOWQ4MTliY2FhNjU0
+    ZDdkMTZjMjlmNDBmMDk4ZTczMzU5ODRhNDMyN2MwZWI4M2UxYTA=
   data.tar.gz: !binary |-
-    Y2Y1NmRhZDQ4MGQ0MTdkYWNlZmZhYTJiYmU4OTM0MWEzODM3NDExOTAyNGRh
-    ZDM3ZDQ5ZDk2MTM1Nzg3N2Y4MDJmMjMzN2Y0MmFiNjE3MWNlYWQ1OTE1ZTE3
-    OTgyZmRkYzg1ZGIwMzIxMGVmOGQ2Yjk4MjFkYzA3ZDY4YjQ0ZWU=
+    YTA1YjBjNGUzMGU4MzZmOGQ2NTBjNzc0NzRlYzVkMzFjYTZhNzIzM2MxNGQw
+    NmM2MjZkODcyMDM2M2EwZDBlMDdmODJiZTlmZTliY2ZmYjMzZTQxY2EyNTU0
+    YmUwMDNmODkwMDBjNzhhYjRjNmU0OTNjMDljOGQzODFhMTU1MDA=

data/README.md

@@ -5,3 +5,33 @@ 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
+
+Installation
+------------
+
+Add to your Gemfile `gem 'coordsafe_api'`
+
+Usage
+-----
+
+Initialize your request. It takes `company_name` and `key` as parameters.
+
+    @api = CoordsafeApi::Locator.new({:company_name => "EdeyaLabs", :secret => "test-1234qwer"})
+
+Use `locate` to get a list of all locators
+
+    request = @api.locate
+    results = request.body #=> Returns an Array of Hashes
+
+Use `locate_history` with the `locator_id` and `date_from` to get the path of the locator at that particular date.
+
+    date_from = DateTime.parse("2013-01-27 9:30")
+    request   = @api.locate_history(18, date_from)
+    results   = request.body #=> Returns an Array of Hashes
+
+Use `locate_history` with the `locator_id`, `date_from` and `date_to` to get the path of a locator within the dates.
+
+    date_from = DateTime.parse("2013-01-27 9:30")
+    date_to   = DateTime.parse("2013-01-27 10:00")
+    request = @api.locate_history(18, date_from, date_to)
+    results = request.body #=> Returns a Hash

data/lib/coordsafe_api/configuration.rb

@@ -4,9 +4,9 @@ module CoordsafeApi
     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_LOCATOR_ENDPOINT        = "http://www.coordsafe.com.sg/geoready/api/locator/company"
+    DEFAULT_HISTORY_ENDPOINT        = "http://www.coordsafe.com.sg/geoready/api/history"
+    DEFAULT_SINGLE_HISTORY_ENDPOINT = "http://www.coordsafe.com.sg/geoready/api/location"
     DEFAULT_METHOD                  = :get
     DEFAULT_USER_AGENT              = "CoordsafeApi Ruby Gem #{CoordsafeApi::VERSION}".freeze
 

data/lib/coordsafe_api/version.rb

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

data/spec/coordsafe_api/locator_spec.rb

@@ -3,7 +3,8 @@ 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"})
+      @api = CoordsafeApi::Locator.new({:company_name => "2", :secret => "test-1234qwer"})
+      <<-DOC
       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,
@@ -20,6 +21,7 @@ describe CoordsafeApi::Locator do
         :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')
+      DOC
     end
 
     it "should respond with the CoordsafeApi::Response object on #locate" do
@@ -49,10 +51,7 @@ describe CoordsafeApi::Locator do
     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
+      results.class.should eq(Hash)
     end
 
     it "should return true for success" do
@@ -68,7 +67,10 @@ describe CoordsafeApi::Locator do
     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)
+      results.class.should eq(Array)
+      results.each do |r|
+        r.class.should eq(Hash)
+      end
     end
 
     it "should return true for success" do

data/spec/spec_helper.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coordsafe_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Vincent Paca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler