hypertrack 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 497161ee6c7532a5d8905a0f5be8659007905b89
-  data.tar.gz: 6c0618355dda776262082d2c88b6beec75468e45
+  metadata.gz: 84303e29979cffc3077bef07b0cdc047c191510a
+  data.tar.gz: d3165cb9c2e75557e1c4eb4f67ab67b63d294ec4
 SHA512:
-  metadata.gz: 3599e44c50219ae6d9e4a4f3dfeb5841f39e9a723054deb9efc1718eab767a11eec6b93e0c2654ec2730d79743fcb182616abfcb4fd2e0d93b18f9e91e84da0c
-  data.tar.gz: 56236254eeb03d089563e775b229e1cc78115b50a1aa74250c3f220a95a868b2ecdad9350dfcf6a3b8a2f2812eae568800596cdd8fe8d1d0a49002f2c8193eb9
+  metadata.gz: e709f5dc1937115e97a1148a386ec28231847abdb4f63366ca9d21b6a7c9889b4abfeaebe1d39e69b945f607a6b6fc1937781d2d289ebb1d7c568713fa36dd09
+  data.tar.gz: ca4f1411f10b913c58cc4a078c1573288b7a14ad567f3bf46a4a7e55e399f9a4ba1e8655f8c14c8d3b03de0d2927c70a58527211ed5d34c29b72cbdb13a42c2e

data/lib/hypertrack.rb

@@ -12,11 +12,8 @@ require_relative "hypertrack/api_operations/common/create"
 require_relative "hypertrack/api_operations/common/retrieve"
 require_relative "hypertrack/api_operations/common/list"
 require_relative "hypertrack/api_operations/common/update"
-require_relative "hypertrack/api_operations/driver_api"
-require_relative "hypertrack/api_operations/task_api"
-require_relative "hypertrack/api_operations/trip_api"
-require_relative "hypertrack/api_operations/shift_api"
-require_relative "hypertrack/api_operations/gps_log_api"
+require_relative "hypertrack/api_operations/user_api"
+require_relative "hypertrack/api_operations/action_api"
 
 # All HTTP calls made here
 require_relative "hypertrack/api_client"
@@ -25,17 +22,8 @@ require_relative "hypertrack/api_client"
 require_relative "hypertrack/shared_resource"
 
 # Resources
-require_relative "hypertrack/resources/driver"
-require_relative "hypertrack/resources/customer"
-require_relative "hypertrack/resources/destination"
-require_relative "hypertrack/resources/task"
-require_relative "hypertrack/resources/trip"
-require_relative "hypertrack/resources/neighbourhood"
-require_relative "hypertrack/resources/fleet"
-require_relative "hypertrack/resources/hub"
-require_relative "hypertrack/resources/shift"
-require_relative "hypertrack/resources/event"
-require_relative "hypertrack/resources/gps_log"
+require_relative "hypertrack/resources/user"
+require_relative "hypertrack/resources/action"
 
 module HyperTrack
 

data/lib/hypertrack/api_client.rb

@@ -1,7 +1,7 @@
 module HyperTrack
   class ApiClient
 
-    BASE_URL = "https://app.hypertrack.io/api"
+    BASE_URL = "https://api.hypertrack.com/api"
     API_VERSION = "v1"
 
     VERB_MAP = {

data/lib/hypertrack/api_operations/action_api.rb

@@ -0,0 +1,17 @@
+module HyperTrack
+  module ApiOperations
+    module ActionAPI
+
+      def complete(params={})
+        path = "complete/"
+        self.update(path, params, [:completion_location])
+      end
+
+      def cancel(params={})
+        path = "cancel/"
+        self.update(path, params)
+      end
+
+    end
+  end
+end

data/lib/hypertrack/api_operations/common/list.rb

@@ -10,7 +10,7 @@ module HyperTrack
             api_result['results'][idx] = get_class_name.new(opts['id'], opts)
           end
 
-          api_result
+          api_result['results']
         end
 
       end

data/lib/hypertrack/api_operations/user_api.rb

@@ -0,0 +1,12 @@
+module HyperTrack
+  module ApiOperations
+    module UserAPI
+
+      def assign_actions(params)
+        path = "assign_actions/"
+        self.update(path, params, [:action_ids])
+      end
+
+    end
+  end
+end

data/lib/hypertrack/errors/hypertrack_errors.rb

@@ -15,7 +15,9 @@ module HyperTrack
         410 => HyperTrack::ResourceRemovedFromServer,
         429 => HyperTrack::RateLimitExceeded,
         500 => HyperTrack::InternalServerError,
-        503 => HyperTrack::ServiceTemporarilyUnavailable
+        502 => HyperTrack::BadGateway,
+        503 => HyperTrack::ServiceTemporarilyUnavailable,
+        504 => HyperTrack::GatewayTimeout
       }
     end
 
@@ -56,9 +58,15 @@ module HyperTrack
   # Raised when - There was an error on the server and we have been notified. Try again later.
   class InternalServerError < Error; end
 
-  # Raised when - We are temporarily offline for maintenance. Please try again later.
+  # Raised when - load balancer throws 502
+  class BadGateway < Error; end
+
+  # Raised when - service throws 500
   class ServiceTemporarilyUnavailable < Error; end
 
+  # Raised when - load balancer throws 504
+  class GatewayTimeout < Error; end
+
   # Raised when - We get an unknown response code from the API
   class UnknownError < Error; end
 

data/lib/hypertrack/resources/action.rb

@@ -0,0 +1,20 @@
+module HyperTrack
+  class Action < HyperTrack::SharedResource
+    include HyperTrack::ApiOperations::ActionAPI
+
+    API_BASE_PATH = "actions/"
+    REQUIRED_FIELDS = []
+
+    VALID_ATTRIBUTE_VALUES = {
+      type: {
+        allowed: [:pickup, :delivery, :dropoff, :visit, :stoppver, :task],
+        allow_nil: true
+      },
+      vehicle_type: {
+        allowed: HyperTrack::SharedResource::VALID_VEHICLE_TYPES,
+        allow_nil: true
+      }
+    }
+
+  end
+end

data/lib/hypertrack/resources/user.rb

@@ -0,0 +1,15 @@
+module HyperTrack
+  class User < HyperTrack::SharedResource
+    include HyperTrack::ApiOperations::UserAPI
+
+    API_BASE_PATH = "users/"
+    REQUIRED_FIELDS = [:name]
+
+    VALID_ATTRIBUTE_VALUES = {
+      vehicle_type: {
+        allowed: HyperTrack::SharedResource::VALID_VEHICLE_TYPES
+      }
+    }
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hypertrack
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Utsav Kesharwani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-01 00:00:00.000000000 Z
+date: 2017-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-description: Ruby wrapper around HyperTrack's API. Refer http://docs.hypertrack.io/
+description: Ruby wrapper around HyperTrack's API. Refer http://docs.hypertrack.com/
   for more information.
 email: utsav.kesharwani@gmail.com
 executables: []
@@ -33,28 +33,16 @@ extra_rdoc_files: []
 files:
 - lib/hypertrack.rb
 - lib/hypertrack/api_client.rb
+- lib/hypertrack/api_operations/action_api.rb
 - lib/hypertrack/api_operations/common/create.rb
 - lib/hypertrack/api_operations/common/list.rb
 - lib/hypertrack/api_operations/common/retrieve.rb
 - lib/hypertrack/api_operations/common/update.rb
-- lib/hypertrack/api_operations/driver_api.rb
-- lib/hypertrack/api_operations/gps_log_api.rb
-- lib/hypertrack/api_operations/shift_api.rb
-- lib/hypertrack/api_operations/task_api.rb
-- lib/hypertrack/api_operations/trip_api.rb
+- lib/hypertrack/api_operations/user_api.rb
 - lib/hypertrack/errors/hypertrack_errors.rb
 - lib/hypertrack/params_validator.rb
-- lib/hypertrack/resources/customer.rb
-- lib/hypertrack/resources/destination.rb
-- lib/hypertrack/resources/driver.rb
-- lib/hypertrack/resources/event.rb
-- lib/hypertrack/resources/fleet.rb
-- lib/hypertrack/resources/gps_log.rb
-- lib/hypertrack/resources/hub.rb
-- lib/hypertrack/resources/neighbourhood.rb
-- lib/hypertrack/resources/shift.rb
-- lib/hypertrack/resources/task.rb
-- lib/hypertrack/resources/trip.rb
+- lib/hypertrack/resources/action.rb
+- lib/hypertrack/resources/user.rb
 - lib/hypertrack/shared_resource.rb
 - lib/util.rb
 homepage: http://rubygems.org/gems/hypertrack
@@ -77,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the HyperTrack API!

data/lib/hypertrack/api_operations/driver_api.rb

@@ -1,25 +0,0 @@
-module HyperTrack
-  module ApiOperations
-    module DriverAPI
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-
-        def map_list(filter_params={})
-          map_list_path = "#{HyperTrack::Driver::API_BASE_PATH}map_list/"
-          HyperTrack::ApiClient.fetch(map_list_path, filter_params)
-        end
-
-      end
-
-      def overview(filter_params={})
-        driver_overview_path = "#{HyperTrack::Driver::API_BASE_PATH}#{self.id}/overview/"
-        HyperTrack::ApiClient.fetch(driver_overview_path, filter_params)
-      end
-
-    end
-  end
-end

data/lib/hypertrack/api_operations/gps_log_api.rb

@@ -1,20 +0,0 @@
-module HyperTrack
-  module ApiOperations
-    module GPSLogAPI
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-
-        def filtered_list(params)
-          if HyperTrack::ParamsValidator.valid_args?(params, [:driver_id], HyperTrack::GPSLog::VALID_ATTRIBUTE_VALUES)
-            HyperTrack::GPSLog.list(params.merge(filtered: true))
-          end
-        end
-
-      end
-    end
-  end
-end

data/lib/hypertrack/api_operations/shift_api.rb

@@ -1,13 +0,0 @@
-module HyperTrack
-  module ApiOperations
-    module ShiftAPI
-
-      # Don't want to name this method as 'end'. Its a reserved keyword in Ruby.
-      def end_shift(params)
-        path = "end/"
-        self.update(path, params, [:end_location])
-      end
-
-    end
-  end
-end

data/lib/hypertrack/api_operations/task_api.rb

@@ -1,34 +0,0 @@
-module HyperTrack
-  module ApiOperations
-    module TaskAPI
-
-      def editable_url(params)
-        if HyperTrack::ParamsValidator.valid_args?(params, [:editable], self.class::VALID_ATTRIBUTE_VALUES)
-          api_path = "#{self.class::API_BASE_PATH}#{self.id}/editable_url/"
-          HyperTrack::ApiClient.update(api_path, params)
-        end
-      end
-
-      def start(params)
-        path = "start/"
-        self.update(path, params, [:start_location, :start_time])
-      end
-
-      def complete(params)
-        path = "completed/"
-        self.update(path, params, [:completion_location])
-      end
-
-      def cancel(params={})
-        path = "canceled/"
-        self.update(path, params)
-      end
-
-      def update_destination(params)
-        path = "update_destination/"
-        self.update(path, params, [:location])
-      end
-
-    end
-  end
-end

data/lib/hypertrack/api_operations/trip_api.rb

@@ -1,43 +0,0 @@
-module HyperTrack
-  module ApiOperations
-    module TripAPI
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-
-        def sending_eta(params)
-          if HyperTrack::ParamsValidator.valid_args?(params, [:driver, :destination], HyperTrack::Trip::VALID_ATTRIBUTE_VALUES)
-            eta_path = "#{HyperTrack::Trip::API_BASE_PATH}lite/"
-            HyperTrack::ApiClient.update(eta_path, params)
-          end
-        end
-
-      end
-
-      # Don't want to name this method as 'end'. Its a reserved keyword in Ruby.
-      def end_trip(params)
-        path = "end/"
-        self.update(path, params, [])
-      end
-
-      def add_task(params)
-        path = 'add_task/'
-        self.update(path, params, [:task_id])
-      end
-
-      def remove_task(params)
-        path = 'remove_task/'
-        self.update(path, params, [:task_id])
-      end
-
-      def change_task_order(params)
-        path = 'change_task_order/'
-        self.update(path, params, [:task_order])
-      end
-
-    end
-  end
-end

data/lib/hypertrack/resources/customer.rb

@@ -1,10 +0,0 @@
-module HyperTrack
-  class Customer < HyperTrack::SharedResource
-
-    API_BASE_PATH = "customers/"
-    REQUIRED_FIELDS = [:name]
-
-    VALID_ATTRIBUTE_VALUES = {}
-
-  end
-end

data/lib/hypertrack/resources/destination.rb

@@ -1,10 +0,0 @@
-module HyperTrack
-  class Destination < HyperTrack::SharedResource
-
-    API_BASE_PATH = "destinations/"
-    REQUIRED_FIELDS = [:customer_id]
-
-    VALID_ATTRIBUTE_VALUES = {}
-
-  end
-end

data/lib/hypertrack/resources/driver.rb

@@ -1,15 +0,0 @@
-module HyperTrack
-  class Driver < HyperTrack::SharedResource
-    include HyperTrack::ApiOperations::DriverAPI
-
-    API_BASE_PATH = "drivers/"
-    REQUIRED_FIELDS = [:name, :vehicle_type]
-
-    VALID_ATTRIBUTE_VALUES = {
-      vehicle_type: {
-        allowed: HyperTrack::SharedResource::VALID_VEHICLE_TYPES
-      }
-    }
-
-  end
-end

data/lib/hypertrack/resources/event.rb

@@ -1,14 +0,0 @@
-module HyperTrack
-  class Event < HyperTrack::SharedResource
-
-    API_BASE_PATH = "events/"
-    REQUIRED_FIELDS = []
-
-    VALID_ATTRIBUTE_VALUES = {}
-
-    def self.create(params={})
-      raise HyperTrack::MethodNotAllowed.new("Create not allowed on HyperTrack::Event class")
-    end
-
-  end
-end

data/lib/hypertrack/resources/fleet.rb

@@ -1,10 +0,0 @@
-module HyperTrack
-  class Fleet < HyperTrack::SharedResource
-
-    API_BASE_PATH = "fleets/"
-    REQUIRED_FIELDS = [:name]
-
-    VALID_ATTRIBUTE_VALUES = {}
-
-  end
-end

data/lib/hypertrack/resources/gps_log.rb

@@ -1,31 +0,0 @@
-module HyperTrack
-  class GPSLog < HyperTrack::SharedResource
-    include HyperTrack::ApiOperations::GPSLogAPI
-
-    API_BASE_PATH = "gps/"
-    REQUIRED_FIELDS = [:driver_id, :location, :speed, :bearing, :altitude, :recorded_at]
-
-    VALID_ATTRIBUTE_VALUES = {
-      activities: {
-        allowed: [:stationary, :walking, :running, :automotive, :cycling, :unknown]
-      },
-      activity_confidence: {
-        allowed: (0..100).to_a
-      }
-    }
-
-    def self.create(params={})
-      raise HyperTrack::MethodNotAllowed.new("Create not allowed on HyperTrack::GPSLog class")
-    end
-
-    def self.list(params={})
-      if params.is_a?(Hash)
-        params[:filtered] ? params.delete(:raw) : params[:raw] = true
-      end
-      params.delete(:filtered)
-
-      super(params)
-    end
-
-  end
-end

data/lib/hypertrack/resources/hub.rb

@@ -1,10 +0,0 @@
-module HyperTrack
-  class Hub < HyperTrack::SharedResource
-
-    API_BASE_PATH = "hubs/"
-    REQUIRED_FIELDS = [:name]
-
-    VALID_ATTRIBUTE_VALUES = {}
-
-  end
-end

data/lib/hypertrack/resources/neighbourhood.rb

@@ -1,14 +0,0 @@
-module HyperTrack
-  class Neighbourhood < HyperTrack::SharedResource
-
-    API_BASE_PATH = "neighborhoods/"
-    REQUIRED_FIELDS = []
-
-    VALID_ATTRIBUTE_VALUES = {}
-
-    def self.create(params={})
-      raise HyperTrack::MethodNotAllowed.new("Create not allowed on HyperTrack::Neighbourhood class")
-    end
-
-  end
-end

data/lib/hypertrack/resources/shift.rb

@@ -1,11 +0,0 @@
-module HyperTrack
-  class Shift < HyperTrack::SharedResource
-    include HyperTrack::ApiOperations::ShiftAPI
-
-    API_BASE_PATH = "shifts/"
-    REQUIRED_FIELDS = [:driver_id, :start_location]
-
-    VALID_ATTRIBUTE_VALUES = {}
-
-  end
-end

data/lib/hypertrack/resources/task.rb

@@ -1,22 +0,0 @@
-module HyperTrack
-  class Task < HyperTrack::SharedResource
-    include HyperTrack::ApiOperations::TaskAPI
-
-    API_BASE_PATH = "tasks/"
-    REQUIRED_FIELDS = []
-
-    VALID_ATTRIBUTE_VALUES = {
-      action: {
-        allowed: [:pickup, :delivery, :visit, :task],
-        allow_nil: true
-      },
-      editable: {
-        allowed: [:'not editable', :once, :multiple]
-      },
-      vehicle_type: {
-        allowed: HyperTrack::SharedResource::VALID_VEHICLE_TYPES
-      }
-    }
-
-  end
-end

data/lib/hypertrack/resources/trip.rb

@@ -1,18 +0,0 @@
-module HyperTrack
-  class Trip < HyperTrack::SharedResource
-    include HyperTrack::ApiOperations::TripAPI
-
-    API_BASE_PATH = "trips/"
-    REQUIRED_FIELDS = [:driver_id]
-
-    VALID_ATTRIBUTE_VALUES = {
-      vehicle_type: {
-        allowed: HyperTrack::SharedResource::VALID_VEHICLE_TYPES
-      },
-      has_ordered_tasks: {
-        allowed: [true, false]
-      }
-    }
-
-  end
-end