syncwise_api 0.0.1

data/lib/syncwise_api/ext/inflector_methods.rb

@@ -0,0 +1,62 @@
+require_relative 'inflections'
+
+# holds 'inflector methods' (to use a Rails term) to change 'words' from one form to another
+module SyncwiseApi
+  module Inflector
+
+    # downcase words, and replace ' ' with '_'. Example 'Big Bob'.dehumanize => 'big_bob'
+    def dehumanize(word)
+      # should be OK to remove the respond_to? as long as we ensure we call this only on Strings or things that can be
+      # cast to Strings
+      #if word.respond_to?(:to_s)
+      dh_word = word.to_s.dup
+      dh_word.gsub!(/ /, '_')
+      dh_word.downcase!
+      dh_word
+      #end
+    end
+
+    def underscore(camel_cased_word)
+      # should be OK to remove the respond_to? as long as we ensure we call this only on Strings or things that can be
+      # cast to Strings
+      #if camel_cased_word.respond_to?(:to_s)
+      word = camel_cased_word.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/(?:([A-Za-z\d])|^)(#{inflections.acronym_regex})(?=\b|[^a-z])/) { "#{$1}#{$1 && '_'}#{$2.downcase}" }
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+      #end
+    end
+
+    # By default, +camelize+ converts strings to UpperCamelCase. If the argument to +camelize+
+    # is set to <tt>:lower</tt> then +camelize+ produces lowerCamelCase.
+    #
+    # +camelize+ will also convert '/' to '::' which is useful for converting paths to namespaces.
+    #
+    # Examples:
+    #   "active_model".camelize                # => "ActiveModel"
+    #   "active_model".camelize(:lower)        # => "activeModel"
+    #   "active_model/errors".camelize         # => "ActiveModel::Errors"
+    #   "active_model/errors".camelize(:lower) # => "activeModel::Errors"
+    #
+    # As a rule of thumb you can think of +camelize+ as the inverse of +underscore+,
+    # though there are cases where that does not hold:
+    #
+    #   "SSLError".underscore.camelize # => "SslError"
+    def camelize(term, uppercase_first_letter = true)
+      string = term.to_s
+      if uppercase_first_letter
+        string = string.sub(/^[a-z\d]*/) { inflections.acronyms[$&] || $&.capitalize }
+      else
+        string = string.sub(/^(?:#{inflections.acronym_regex}(?=\b|[A-Z_])|\w)/) { $&.downcase }
+      end
+      string.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{inflections.acronyms[$2] || $2.capitalize}" }.gsub('/', '::')
+    end
+
+    module_function :dehumanize, :underscore, :camelize
+
+  end
+end

data/lib/syncwise_api/ext/string_encoding.rb

@@ -0,0 +1,12 @@
+# ripped from rails
+class String
+  if defined?(Encoding) && "".respond_to?(:encode)
+    def encoding_aware?
+      true
+    end
+  else
+    def encoding_aware?
+      false
+    end
+  end
+end

data/lib/syncwise_api/mixins/mixins.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname(__FILE__)}/**/*.rb"].each { |f| require f }

data/lib/syncwise_api/mixins/request_builder.rb

@@ -0,0 +1,23 @@
+# Currently not used
+#module SyncwiseApi
+#  module Mixins
+#    module RequestBuilder
+#
+#      def extract_header_params
+#        # first, we have to make sure that this is mixed into a class that has a @param instance variable
+#        # and that has a superclass with a required_header_params method
+#        if !self.instance_variable_defined?(:@params)
+#          fail SyncwiseApi::Errors::MissingInstanceVariable.new(:@params, SyncwiseApi::Mixins::RequestBuilder, self)
+#        elsif !self.superclass.respond_to?(:required_header_params)
+#          fail SyncwiseApi::Errors::MissingMethod.new(:required_header_params, SyncwiseApi::Mixins::RequestBuilder, self)
+#        else
+#          # as crazy as this looks, all it does is pull out the required header params from the @params hash, which holds
+#          # any dynamically supplied params, and add them to the @header hash, which holds the header params
+#          @header = {}
+#          self.superclass.required_header_params.each { |key| @header[key] = @params.delete(key) }
+#        end
+#      end
+#
+#    end
+#  end
+#end

data/lib/syncwise_api/mixins/request_sender.rb

@@ -0,0 +1,11 @@
+# using Net::Http to make requests to avoid external gem dependencies
+module SyncwiseApi
+  module Mixins
+    module RequestSender
+
+      def send
+        #TODO: make request to syncwise
+      end
+    end
+  end
+end

data/lib/syncwise_api/mixins/request_signer.rb

@@ -0,0 +1,20 @@
+module SyncwiseApi
+  module Mixins
+    module RequestSigner
+
+      def sign
+        if !self.instance_variable_defined?(:@params)
+          fail SyncwiseApi::Errors::MissingInstanceVariable.new(:@request, SyncwiseApi::Mixins::RequestSigner, self)
+        elsif !self.instance_variable_defined?(:@header)
+          fail SyncwiseApi::Errors::MissingInstanceVariable.new(:@header, SyncwiseApi::Mixins::RequestSigner, self)
+        else
+
+        end
+      end
+
+      private
+
+
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/assign_device_create.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class AssignDeviceCreate < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:deviceList]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/base.rb

@@ -0,0 +1,115 @@
+require 'openssl'
+
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class Base
+        #include SyncwiseApi::Mixins::RequestBuilder
+        #include SyncwiseApi::Mixins::RequestSigner
+        #include SyncwiseApi::Mixins::RequestSender
+
+        # @required_header_params represents the keys required by all required for all Syncwise API calls, and CHANGE on a per call basis
+        # thus, they must be present (have values) in the paramss passed to #initialize when creating a new object that
+        # inherits from this class (Base)
+        #TODO: Make this a class constant?
+        @required_header_params = [:'API Key', :'Action Code']
+        @required_header_params.freeze
+
+        # @default_header_params holds key/values that are universally required for all Syncwise API calls, and DO NOT CHANGE
+        #TODO: Make this a class constant?
+        @default_header_params = {:'API Version' => 1.0, :'Signature Version' => 1, :'Signature Method' => 'HmacSHA256', :'Response Format' => 'JSON'}
+        @default_header_params.freeze
+
+        # @required_params represents all the params (both header and payload) that must be passed to #initialize when
+        # creating a new object that inherits from this class (Base)
+        #TODO: Make this a class constant?
+        @required_params = [:secretKey, :accountId]
+        @required_params.concat(@required_header_params)
+        @required_params.freeze
+
+        HOST_HEADER = 'api-int.syncwise.com'
+        BASE_URL = "https://#{HOST_HEADER}/rest/action"
+
+        class << self
+          attr_reader :required_header_params, :default_header_params, :required_params, :host_header
+        end
+
+        def initialize(params = {})
+          # Add the action code to params based on the child class's name
+          params[:'Action Code'] = self.unqualified_class
+
+          # Verify we have all required params by comparing child class's required_params to the passed in params
+          param_keys = params.keys.sort
+
+          fail SyncwiseApi::Errors::InvalidParameters.new(self.class, param_keys, self.class.required_params) unless param_keys & self.class.required_params == self.class.required_params
+          # remove the signing key from params and store it for use when building the HMAC signature
+          @secret_key = params.delete(:secretKey)
+
+          # @params now holds the params we need to build the header_hash
+          @params = params
+
+          build_header_hash
+
+          # after build_header_hash returns, we have @header which holds all values needed to build the request and signature
+          # and @params which now only contains the values that will be added to the JSON payload
+        end
+
+        def send_request
+          request_string = build_api_call
+          body = build_body
+          # TODO: send POST with Net::Http to request_string with JSON payload body
+          SyncwiseApi::ServiceUtils::HTTP.post(request_string, body) do |http_response|
+            SyncwiseApi::Responses::V1_0::Standard.new(http_response)
+          end
+        end
+
+        private
+
+        def build_header_hash
+          # pull out the required header params from the @params hash, which holds
+          # any dynamically supplied params, and add them to the @header hash, which holds the header params
+          @header = {}.merge(SyncwiseApi::Requests::V1_0::Base.default_header_params)
+          SyncwiseApi::Requests::V1_0::Base.required_header_params.each { |key| @header[key] = @params.delete(key) }
+          @header[:Timestamp] = SyncwiseApi::ServiceUtils::Timestamper.stamp
+        end
+
+        def build_api_call
+          "#{SyncwiseApi::Requests::V1_0::Base::BASE_URL}/#{@header[:'Action Code']}/#{@header[:'API Key']}/#{@header[:'API Version']}/#{@header[:'Signature Version']}/#{@header[:'Signature Method']}/#{create_signature}/#{@header[:Timestamp]}/#{@header[:'Response Format']}"
+        end
+
+        def build_body
+          SyncwiseApi::ServiceUtils::Encoders::JSON.encode(@params)
+        end
+
+        def create_signature
+          bin_hmac = SyncwiseApi::ServiceUtils::Crypto::HmacSha256.crypt(@secret_key, string_to_sign)
+          base64_hmac = SyncwiseApi::ServiceUtils::Encoders::Base64.encode(bin_hmac)
+          replace_bad_chars(base64_hmac)
+        end
+
+        def string_to_sign
+          "#{self.class.verb}\n#{SyncwiseApi::Requests::V1_0::Base::HOST_HEADER}\n#{canonicalized_query_string}"
+        end
+
+        def canonicalized_query_string
+          sorted_header_array = @header.to_a.sort
+          query_string = ''
+          sorted_header_array.each do |key_value_array|
+            query_string = query_string + "&#{key_value_array[0]}=#{key_value_array[1]}"
+          end
+
+          query_string
+        end
+
+        def replace_bad_chars(encoded_string)
+          encoded_string.gsub!('/', 'A')
+          encoded_string.gsub!('+', 'B')
+          encoded_string.gsub!('=', 'C')
+          encoded_string.gsub!('&', 'D')
+          encoded_string
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/device_details.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class DeviceDetails < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:deviceId]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/device_list.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class DeviceList < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = []
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/device_settings_details.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class DeviceSettingsDetails < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:deviceId, :settingsStatus]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/device_settings_edit.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class DeviceSettingsEdit < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:deviceId, :appTypeVer, :deviceSettings]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/device_subscribe.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class DeviceSubscribe < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:deviceList]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/device_unsubscribe.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class DeviceUnsubscribe < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:deviceList]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/driver_speed_report.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class DriverSpeedReport < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:deviceId, :endDate, :startDate]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/obd_vehicle_details.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class OBDVehicleDetails < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:deviceId]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/trip_event_details.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class TripEventDetails < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:deviceId, :tripId]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/user_login.rb

@@ -0,0 +1,26 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class UserLogin < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:password]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+        # overrides create_signature in Base, because for this request only, no signature is possible since we
+        # don't have a secret key yet. the service still requires a dummy value here, though, so just quickly return a
+        # valid, but dummy, signature string
+        def create_signature
+          'k8NipGDhzthk0EJRmHCBy2NcwSsC'
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/user_subscribe_settings_details.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class UserSubscribeSettingsDetails < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = []
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/vehicle_gauge_information.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class VehicleGaugeInformation < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:deviceId, :gaugeMap, :endDate, :startDate]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/V1_0/vehicle_idling_history.rb

@@ -0,0 +1,19 @@
+module SyncwiseApi
+  module Requests
+    module V1_0
+      class VehicleIdlingHistory < Base
+
+        #TODO: this is janky. Fix it. Class constants? Something in Base? Not sure...
+        my_required_params = [:deviceId, :endDate, :startDate]
+        @required_params = my_required_params.concat(self.superclass.required_params)
+        @required_params.sort!.freeze
+        @verb = 'POST'
+
+        class << self
+          attr_reader :required_params, :verb
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/requests/requests.rb

@@ -0,0 +1,2 @@
+require_relative 'V1_0/base'
+Dir["#{File.dirname(__FILE__)}/**/*.rb"].each { |f| require f }

data/lib/syncwise_api/responses/V1_0/base.rb

@@ -0,0 +1,35 @@
+module SyncwiseApi
+  module Responses
+    module V1_0
+      class Base
+
+        def initialize(http_response_object)
+          @http_response_object = http_response_object
+          @body = @http_response_object.body
+          @header_hash = @http_response_object.header.to_hash.symbolize_keys
+          @body_hash = parse
+        end
+
+        attr_reader :body_hash
+
+        def valid?
+          @body_hash[:sts] == '1'
+        end
+
+        private
+
+        def parse
+          # if the response has a body, and the body is json, parse and store it in @body_hash; otherwise throw an error
+          if @body.blank?
+            fail SyncwiseApi::Errors::EmptyResponseBody.new(@http_response_object, @http_response_object.uri, @header_hash)
+          elsif !@header_hash[:content_type].include?('application/json')
+            fail SyncwiseApi::Errors::InvalidContentType.new(@http_response_object, @http_response_object.uri, @header_hash)
+          else
+            SyncwiseApi::ServiceUtils::Parsers::JSON.parse(@body).symbolize_keys
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/responses/V1_0/standard.rb

@@ -0,0 +1,9 @@
+module SyncwiseApi
+  module Responses
+    module V1_0
+      class Standard < Base
+
+      end
+    end
+  end
+end

data/lib/syncwise_api/responses/responses.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname(__FILE__)}/**/*.rb"].each { |f| require f }

data/lib/syncwise_api/service_utils/crypto/hmac_sha256.rb

@@ -0,0 +1,15 @@
+module SyncwiseApi
+  module ServiceUtils
+    module Crypto
+      module HmacSha256
+
+        def crypt(secret_key, string_to_sign)
+          digest = OpenSSL::Digest::Digest.new('sha256')
+          OpenSSL::HMAC.digest(digest, secret_key, string_to_sign)
+        end
+
+        module_function :crypt
+      end
+    end
+  end
+end

data/lib/syncwise_api/service_utils/encoders/base64.rb

@@ -0,0 +1,16 @@
+require 'base64'
+
+module SyncwiseApi
+  module ServiceUtils
+    module Encoders
+      module Base64
+
+        def encode(body)
+          ::Base64.strict_encode64(body)
+        end
+
+        module_function :encode
+      end
+    end
+  end
+end

data/lib/syncwise_api/service_utils/encoders/json.rb

@@ -0,0 +1,21 @@
+require 'yajl'
+
+module SyncwiseApi
+  module ServiceUtils
+    module Encoders
+      module JSON
+
+        def encode(object)
+          if object.is_a?(Hash) || object.is_a?(Array)
+            Yajl::Encoder.encode(object)
+          else
+            fail SyncwiseApi::Errors::JSONEncodeError.new(object)
+          end
+        end
+
+        module_function :encode
+
+      end
+    end
+  end
+end