onfleet-ruby 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 298c2c7a63d016fd61101c6c30229a3e7700868d
-  data.tar.gz: 285a8280869fe460c29561093272d7d4cb682169
+SHA256:
+  metadata.gz: 5fd31c23992d29f9cc2eed9330212acf71eab0988dbb1d7d99f9c06447af56f6
+  data.tar.gz: 82499d975b1ecaf3487096580a775a00d08c5f59d4dd7769627e1c1800dfc6fa
 SHA512:
-  metadata.gz: 840dd631d9fe75349761d363dcf220f4829b49af17b40cd49abdabb1c775bfd271475217b730be4ae174467246c9142959ff853d3c746dd033bf7b478f965e45
-  data.tar.gz: 1b2c32961b36185eeaed57d7949c44950119b34a0c6799bb41d6324719b1c1aebe322e59f5cad0ccb4fd54a639d11eddc0019eee6036861438d5e84913aed97b
+  metadata.gz: 01ab99e61bcadbb621cfe07fbc23aa36454f7972c4dbeb70cb8f69547c09113de7a1d13f57109d910abfa1f30f9bfed31658afa6626a3c114b1d815ce5496bda
+  data.tar.gz: 76795dae4abf9bb143a5226617128aa08ed6b97a937384ef806386a20bc2730f42503553795b7e27291f353077af3e5c6147639a590f278d9dbefee05a6d8b81

data/.gitignore

@@ -5,3 +5,6 @@
 # Ignore bundler config
 /.bundle
 Gemfile.lock
+
+spec/examples.txt
+

data/.rspec

@@ -1,2 +1 @@
---color
---format documentation
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,26 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.2
+
+# Keep diffs clean
+Layout/TrailingBlankLines:
+  EnforcedStyle: final_blank_line
+
+# No way to avoid large blocks in RSpec
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+# Allow the gem to have a non-snakecase name
+Naming/FileName:
+  Exclude:
+    - 'lib/onfleet-ruby.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Exclude:
+    - spec/**/*
+

data/.rubocop_todo.yml

@@ -0,0 +1,38 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-05-13 20:30:59 -0400 using RuboCop version 0.55.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 26
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 22
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Offense count: 29
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: when_needed, always, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 9
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 138
+

data/.ruby-version

@@ -0,0 +1,2 @@
+2.5.1
+

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gemspec
-gem 'rest-client', '~> 1.6.8'
+ruby '2.5.1'
 
+gemspec
 

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec rubocop]
+

data/lib/onfleet-ruby.rb

@@ -35,66 +35,68 @@ require 'onfleet-ruby/vehicle'
 require 'onfleet-ruby/worker'
 require 'onfleet-ruby/webhook'
 
-
 module Onfleet
-  @base_url = "https://onfleet.com/api/v2"
+  @base_url = 'https://onfleet.com/api/v2/'
 
   class << self
-    attr_accessor :api_key, :base_url, :encoded_api_key
-  end
-
-  def self.request api_url, method, params={}
-    raise AuthenticationError.new("Set your API Key using Onfleet.api_key = <API_KEY>") unless @api_key
+    attr_accessor :api_key, :base_url
 
-    begin
-      response = RestClient::Request.execute(method: method, url: self.base_url+api_url, payload: params.to_json, headers: self.request_headers)
+    def request(api_url, method, params = {})
+      raise(AuthenticationError, 'Set your API Key using Onfleet.api_key = <API_KEY>') unless api_key
 
-      if response != ''
-        JSON.parse(response)
-      end
-    rescue RestClient::ExceptionWithResponse => e
-      if response_code = e.http_code and response_body = e.http_body
-        handle_api_error(response_code, JSON.parse(response_body))
-      else
+      begin
+        url = URI.join(base_url, api_url).to_s
+        response = RestClient::Request.execute(method: method, url: url, payload: params.to_json, headers: request_headers)
+        JSON.parse(response) unless response.empty?
+      rescue RestClient::ExceptionWithResponse => e
+        if (response_code = e.http_code) && (response_body = e.http_body)
+          handle_api_error(response_code, JSON.parse(response_body))
+        else
+          handle_restclient_error(e)
+        end
+      rescue RestClient::Exception, Errno::ECONNREFUSED => e
         handle_restclient_error(e)
       end
-    rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      handle_restclient_error(e)
     end
-  end
 
-  private
-    def self.request_headers
+    private
+
+    def request_headers
       {
-        Authorization: "Basic #{self.encoded_api_key}"
+        Authorization: "Basic #{encoded_api_key}",
+        content_type: :json,
+        accept: :json
       }
     end
 
-    def self.encoded_api_key
-      @encoded_api_key ||= Base64.urlsafe_encode64(@api_key)
+    def encoded_api_key
+      @encoded_api_key ||= Base64.urlsafe_encode64(api_key)
     end
 
-    def self.handle_api_error code, body
+    def handle_api_error(code, body)
       case code
       when 400, 404
-        raise InvalidRequestError.new(body["message"])
+        raise InvalidRequestError, body['message']
       when 401
-        raise AuthenticationError.new(body["message"])
+        raise AuthenticationError, body['message']
       else
-        raise OnfleetError.new(body["message"])
+        raise OnfleetError, body['message']
       end
     end
 
-    def self.handle_restclient_error e
-      case e
-      when RestClient::RequestTimeout
-        message = "Could not connect to Onfleet. Check your internet connection and try again."
-      when RestClient::ServerBrokeConnection
-        message = "The connetion with onfleet terminated before the request completed. Please try again."
-      else
-        message = "There was a problem connection with Onfleet. Please try again. If the problem persists contact contact@onfleet.com"
-      end
+    def handle_restclient_error(exception)
+      message =
+        case exception
+        when RestClient::RequestTimeout
+          'Could not connect to Onfleet. Check your internet connection and try again.'
+        when RestClient::ServerBrokeConnection
+          'The connetion with onfleet terminated before the request completed. Please try again.'
+        else
+          'There was a problem connection with Onfleet. Please try again. If the problem persists contact contact@onfleet.com'
+        end
 
-      raise ConnectionError.new(message)
+      raise ConnectionError, message
     end
+  end
 end
+

data/lib/onfleet-ruby/actions/create.rb

@@ -1,15 +1,18 @@
+require 'active_support/core_ext/hash'
+
 module Onfleet
   module Actions
     module Create
       module ClassMethods
-        def create params={}
-          self.new(params).save
+        def create(params = {})
+          new(params.symbolize_keys.except(:id)).save
         end
       end
 
-      def self.included base
+      def self.included(base)
         base.extend(ClassMethods)
       end
     end
   end
 end
+

data/lib/onfleet-ruby/actions/delete.rb

@@ -2,16 +2,16 @@ module Onfleet
   module Actions
     module Delete
       module ClassMethods
-        def delete id
-          api_url = "#{self.api_url}/#{id}"
-          response = Onfleet.request(api_url, :delete)
+        def delete(id)
+          Onfleet.request("#{api_url}/#{id}", :delete)
           true
         end
       end
 
-      def self.included base
+      def self.included(base)
         base.extend(ClassMethods)
       end
     end
   end
 end
+

data/lib/onfleet-ruby/actions/find.rb

@@ -2,17 +2,19 @@ module Onfleet
   module Actions
     module Find
       module ClassMethods
-        def find field, search_term
-          encoded_term = URI::encode(search_term)
-          api_url = "#{self.api_url}/#{field}/#{encoded_term}"
-          response = Onfleet.request(api_url, :get, search_term)
-          Util.constantize("#{self}").new(response)
+        def find(field, search_term)
+          encoded_term = URI.encode_www_form_component(search_term)
+          url = "#{api_url}/#{field}/#{encoded_term}"
+
+          response = Onfleet.request(url, :get)
+          new(response)
         end
       end
 
-      def self.included base
+      def self.included(base)
         base.extend(ClassMethods)
       end
     end
   end
 end
+

data/lib/onfleet-ruby/actions/get.rb

@@ -2,16 +2,17 @@ module Onfleet
   module Actions
     module Get
       module ClassMethods
-        def get id
+        def get(id)
           api_url = "#{self.api_url}/#{id}"
-          response  = Onfleet.request(api_url, :get)
-          Util.constantize("#{self}").new(response)
+          response = Onfleet.request(api_url, :get)
+          Util.constantize(name).new(response)
         end
       end
 
-      def self.included base
+      def self.included(base)
         base.extend(ClassMethods)
       end
     end
   end
 end
+

data/lib/onfleet-ruby/actions/list.rb

@@ -2,26 +2,28 @@ module Onfleet
   module Actions
     module List
       module ClassMethods
-        def list query_params={}
-          api_url = "#{self.api_url}"
+        def list(filters = {})
+          response = Onfleet.request(list_url_for(filters), :get)
+          response.compact.map { |item| new(item) }
+        end
+
+        private
 
-          if !query_params.empty?
-            api_url += "?"
-            query_params.each do |key, value|
-              api_url += "#{key}=#{value}&"
-            end
-          end
+        def list_url_for(filters)
+          [api_url, query_params(filters)].compact.join('?')
+        end
 
-          response = Onfleet.request(api_url, :get)
-          response.compact.map do |listObj|
-            Util.constantize("#{self}").new(listObj)
-          end
+        def query_params(filters)
+          filters && filters
+            .collect { |key, value| "#{key}=#{URI.encode_www_form_component(value)}" }
+            .join('&')
         end
       end
 
-      def self.included base
+      def self.included(base)
         base.extend(ClassMethods)
       end
     end
   end
 end
+

data/lib/onfleet-ruby/actions/query_metadata.rb

@@ -2,16 +2,16 @@ module Onfleet
   module Actions
     module QueryMetadata
       module ClassMethods
-        def query_by_metadata metadata
-          api_url = "#{self.api_url}/metadata"
-          response = Onfleet.request(api_url, :post, metadata)
-          response.map { |item| Util.constantize("#{self}").new(item) } if response.is_a? Array
+        def query_by_metadata(metadata)
+          response = Onfleet.request("#{api_url}/metadata", :post, metadata)
+          [*response].compact.map { |item| new(item) }
         end
       end
 
-      def self.included base
+      def self.included(base)
         base.extend(ClassMethods)
       end
     end
   end
 end
+

data/lib/onfleet-ruby/actions/save.rb

@@ -2,16 +2,20 @@ module Onfleet
   module Actions
     module Save
       def save
-        if respond_to?('id') && self.id
-          request_type = :put
-          api_url = "#{self.api_url}/#{self.id}"
-        else
-          request_type  = :post
-          api_url = self.api_url
-        end
-        response = Onfleet.request(api_url, request_type, self.attributes)
-        self.parse_response(response)
+        response = Onfleet.request(save_url, request_type, attributes)
+        parse_response(response)
+      end
+
+      private
+
+      def request_type
+        id ? :put : :post
+      end
+
+      def save_url
+        [api_url, id].compact.join('/')
       end
     end
   end
 end
+

data/lib/onfleet-ruby/actions/update.rb

@@ -2,15 +2,15 @@ module Onfleet
   module Actions
     module Update
       module ClassMethods
-        def update id, params
-          params.merge!(id: id)
-          self.new(params).save
+        def update(id, params)
+          new(params.merge(id: id)).save
         end
       end
 
-      def self.included base
+      def self.included(base)
         base.extend(ClassMethods)
       end
     end
   end
 end
+

data/lib/onfleet-ruby/address.rb

@@ -2,3 +2,4 @@ module Onfleet
   class Address < OnfleetObject
   end
 end
+

data/lib/onfleet-ruby/admin.rb

@@ -8,7 +8,8 @@ module Onfleet
     include Onfleet::Actions::QueryMetadata
 
     def self.api_url
-      '/admins'
+      'admins'
     end
   end
 end
+