onfleet-ruby 0.1.4 → 0.1.5

data/lib/onfleet-ruby/destination.rb

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

data/lib/onfleet-ruby/errors/authentication_error.rb

@@ -1,3 +1,4 @@
 module Onfleet
   class AuthenticationError < OnfleetError; end
 end
+

data/lib/onfleet-ruby/errors/connection_error.rb

@@ -1,3 +1,4 @@
 module Onfleet
   class ConnectionError < OnfleetError; end
 end
+

data/lib/onfleet-ruby/errors/invalid_request_error.rb

@@ -1,3 +1,4 @@
 module Onfleet
   class InvalidRequestError < OnfleetError; end
 end
+

data/lib/onfleet-ruby/errors/onfleet_error.rb

@@ -1,3 +1,4 @@
 module Onfleet
   class OnfleetError < StandardError; end
 end
+

data/lib/onfleet-ruby/onfleet_object.rb

@@ -1,102 +1,101 @@
 module Onfleet
   class OnfleetObject
     attr_reader :params
-    def initialize params
-      if params.kind_of?(Hash)
+    attr_accessor :id
+
+    def initialize(params)
+      if params.is_a?(Hash)
         @params = params
-        set_attributes(@params)
-      elsif params.kind_of?(String)
-        @params = {id: params}
-        set_attributes(@params)
+        assign_attributes(@params)
+      elsif params.is_a?(String)
+        @params = { id: params }
+        assign_attributes(@params)
       else
         @params = {}
       end
     end
 
-    def parse_response response
+    def parse_response(response)
       @params = response
-      set_attributes(response)
+      assign_attributes(response)
       self
     end
 
     def attributes
-      attrs = Hash.new
-      instance_variables.each do |var|
-        str = var.to_s.gsub /^@/, ''
-        if respond_to? "#{str}="
-          instance_var = instance_variable_get(var)
-          if klass = Util.object_classes[str]
-            if instance_var.is_a?(OnfleetObject)
-              attrs[Util.to_camel_case_lower(str).to_sym] = parse_onfleet_obj(instance_var)
-            elsif instance_var.is_a?(Array)
-              objs = []
-              instance_var.each do |object|
-                objs << parse_onfleet_obj(object)
-              end
-              attrs[Util.to_camel_case_lower(str).to_sym] = objs
-            else
-              attrs[Util.to_camel_case_lower(str).to_sym] = instance_var
+      attrs = {}
+      instance_variables.reject { |var| var == '@params' }.each do |var|
+        str = var.to_s.gsub(/^@/, '')
+        next unless respond_to?("#{str}=")
+        instance_var = instance_variable_get(var)
+        if Util.object_classes[str]
+          if instance_var.is_a?(OnfleetObject)
+            attrs[Util.to_camel_case_lower(str).to_sym] = parse_onfleet_obj(instance_var)
+          elsif instance_var.is_a?(Array)
+            objs = []
+            instance_var.each do |object|
+              objs << parse_onfleet_obj(object)
             end
+            attrs[Util.to_camel_case_lower(str).to_sym] = objs
           else
             attrs[Util.to_camel_case_lower(str).to_sym] = instance_var
           end
+        else
+          attrs[Util.to_camel_case_lower(str).to_sym] = instance_var
         end
       end
       attrs
     end
 
     def class_name
-      self.class.name.split("::").last
+      self.class.name.split('::').last
     end
 
     def api_url
-      "/#{CGI.escape(class_name.downcase)}s"
+      "#{CGI.escape(class_name.downcase)}s"
     end
 
     private
 
-      def parse_onfleet_obj obj
-        if obj.is_a?(OnfleetObject)
-          if obj.respond_to?('id') && obj.id && (obj.is_a?(Destination) || obj.is_a?(Recipient) || obj.is_a?(Task))
-             obj.id
-          else
-            obj.attributes
-          end
-        end
+    def parse_onfleet_obj(obj)
+      return unless obj.is_a?(OnfleetObject)
+      if obj.respond_to?('id') && obj.id && (obj.is_a?(Destination) || obj.is_a?(Recipient) || obj.is_a?(Task))
+        obj.id
+      else
+        obj.attributes
       end
+    end
 
-      def set_attributes params
-        params.each do |key, value|
-          key_underscore = Util.to_underscore(key)
+    def assign_attributes(params)
+      params.each do |key, value|
+        key_underscore = Util.to_underscore(key)
 
-          if klass = Util.object_classes[key.to_s]
-            case value
-            when Array
-              objs = []
-              value.each do |v|
-                objs << klass.new(v)
-              end
-              value = objs
-            when Hash
-              value = klass.new(value)
+        if (klass = Util.object_classes[key.to_s])
+          case value
+          when Array
+            objs = []
+            value.each do |v|
+              objs << klass.new(v)
             end
+            value = objs
+          when Hash
+            value = klass.new(value)
           end
-
-          if respond_to?("#{key_underscore}=")
-            send(:"#{key_underscore}=", value)
-          else
-            add_attrs({"#{key_underscore}" => value})
-          end
-
         end
-      end
 
-      def add_attrs attrs
-        attrs.each do |var, value|
-          self.class.class_eval { attr_accessor var }
-          instance_variable_set "@#{var}", value
+        if respond_to?("#{key_underscore}=")
+          send(:"#{key_underscore}=", value)
+        else
+          add_attrs(key_underscore.to_s => value)
         end
       end
+    end
 
+    def add_attrs(attrs)
+      attrs.each do |var, value|
+        self.class.class_eval { attr_accessor var }
+        instance_variable_set "@#{var}", value
+      end
+    end
   end
 end
+

data/lib/onfleet-ruby/organization.rb

@@ -1,19 +1,14 @@
 module Onfleet
   class Organization < OnfleetObject
-
     class << self
       def get
-        url = "/organization"
-        response  = Onfleet.request(url, :get)
-        Util.constantize("#{self}").new(response)
+        new(Onfleet.request('organization', :get))
       end
 
-      def get_delegatee_details id
-        url = "/organizations/#{id}"
-        response  = Onfleet.request(url, :get)
-        Util.constantize("#{self}").new(response)
+      def get_delegatee_details(id)
+        new(Onfleet.request("organizations/#{id}", :get))
       end
     end
-
   end
 end
+

data/lib/onfleet-ruby/recipient.rb

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

data/lib/onfleet-ruby/task.rb

@@ -9,16 +9,16 @@ module Onfleet
     include Onfleet::Actions::QueryMetadata
 
     def self.api_url
-      '/tasks'
+      'tasks'
     end
 
     def complete
       # CURRENTLY DOESN'T WORK
-      url = "#{self.url}/#{self.id}/complete"
-      params = {"completionDetails" => {"success" => true }}
+      url = "#{self.url}/#{id}/complete"
+      params = { 'completionDetails' => { 'success' => true } }
       Onfleet.request(url, :post, params)
       true
     end
-
   end
 end
+

data/lib/onfleet-ruby/team.rb

@@ -4,7 +4,8 @@ module Onfleet
     include Onfleet::Actions::Get
 
     def self.api_url
-      '/teams'
+      'teams'
     end
   end
 end
+

data/lib/onfleet-ruby/util.rb

@@ -1,35 +1,37 @@
+require 'active_support/core_ext/string/inflections'
+
 module Onfleet
   class Util
-    def self.constantize class_name
+    SPECIAL_PARSE = { 'skip_sms_notifications' => 'skipSMSNotifications' }.freeze
+
+    def self.constantize(class_name)
       Object.const_get(class_name)
     end
 
-    def self.to_underscore key
-      if key.kind_of?(Symbol)
-        key = key.to_s
-      end
-      key.gsub(/::/, '/').
-          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').
-          tr("-", "_").
-          downcase
+    def self.to_underscore(key)
+      key
+        .to_s
+        .gsub(/::/, '/')
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr('-', '_')
+        .downcase
     end
 
-    def self.to_camel_case_lower str
-      str.split('_').inject([]){ |buffer,e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
-
+    def self.to_camel_case_lower(str)
+      SPECIAL_PARSE[str] || str.camelize(:lower)
     end
 
     def self.object_classes
       @object_classes ||= {
-        "address"     => Address,
-        "recipients"  => Recipient,
-        "recipient"   => Recipient,
-        "tasks"       => Task,
-        "destination" => Destination,
-        "vehicle"     => Vehicle
+        'address'     => Address,
+        'recipients'  => Recipient,
+        'recipient'   => Recipient,
+        'tasks'       => Task,
+        'destination' => Destination,
+        'vehicle'     => Vehicle
       }
     end
   end
-
 end
+

data/lib/onfleet-ruby/vehicle.rb

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

data/lib/onfleet-ruby/webhook.rb

@@ -5,9 +5,9 @@ module Onfleet
     include Onfleet::Actions::Save
     include Onfleet::Actions::Delete
 
-
     def self.api_url
-      '/webhooks'
+      'webhooks'
     end
   end
 end
+

data/lib/onfleet-ruby/worker.rb

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

data/onfleet-ruby.gemspec

@@ -1,20 +1,25 @@
 Gem::Specification.new do |s|
   s.name        = 'onfleet-ruby'
-  s.version     = '0.1.4'
+  s.version     = '0.1.5'
   s.date        = '2016-04-08'
-  s.summary     = "Onfleet ruby api"
+  s.summary     = 'Onfleet ruby api'
   s.description = "To interact with Onfleet's API"
-  s.authors     = ["Nick Wargnier"]
+  s.authors     = ['Nick Wargnier']
   s.email       = 'nick@stylelend.com'
   s.homepage    = 'http://rubygems.org/gems/onfleet-ruby'
   s.license     = 'MIT'
 
-  s.add_dependency('rest-client', '~> 1.4')
-
-  s.add_development_dependency("rspec",'~> 3.3.0', '>= 3.0.0')
+  s.add_dependency('activesupport', '>= 4.2')
+  s.add_dependency('rest-client', '>= 2.0')
 
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '~> 3.3')
+  s.add_development_dependency('rspec-its')
+  s.add_development_dependency('rubocop', '~> 0.55')
+  s.add_development_dependency('webmock', '~> 3.4')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ['lib']
 end
+

data/spec/onfleet/admin_spec.rb

@@ -0,0 +1,70 @@
+RSpec.describe Onfleet::Admin do
+  let(:admin) { described_class.new(params) }
+  let(:params) { { id: 'an-admin', name: 'An Admin' } }
+
+  describe ".list" do
+    subject { -> { described_class.list(query_params) } }
+
+    context "with no filter" do
+      let(:query_params) { nil }
+      it_should_behave_like Onfleet::Actions::List, path: 'admins'
+    end
+
+    context "with query params" do
+      let(:query_params) { { food: 'pizza', topping: 'mushroom' } }
+      it_should_behave_like Onfleet::Actions::List, path: 'admins?food=pizza&topping=mushroom'
+    end
+
+    context "with a URL-unsafe query param" do
+      let(:query_params) { { food: 'green eggs & ham' } }
+      it_should_behave_like Onfleet::Actions::List, path: 'admins?food=green+eggs+%26+ham'
+    end
+  end
+
+  describe ".create" do
+    subject { -> { described_class.create(params) } }
+    it_should_behave_like Onfleet::Actions::Create, path: 'admins'
+  end
+
+  describe ".update" do
+    subject { -> { described_class.update(id, params) } }
+    let(:id) { 'an-admin' }
+    it_should_behave_like Onfleet::Actions::Update, path: 'admins/an-admin'
+  end
+
+  describe ".delete" do
+    subject { -> { described_class.delete(id) } }
+    let(:id) { 'an-admin' }
+    it_should_behave_like Onfleet::Actions::Delete, path: 'admins/an-admin'
+  end
+
+  describe ".query_by_metadata" do
+    subject { -> { described_class.query_by_metadata(metadata) } }
+    let(:metadata) { [{ name: 'color', type: 'string', value: 'ochre' }] }
+    it_should_behave_like Onfleet::Actions::QueryMetadata, path: 'admins'
+  end
+
+  describe "#save" do
+    subject { -> { admin.save } }
+
+    context "with an ID attribute" do
+      before { expect(params[:id]).to be }
+      it_should_behave_like Onfleet::Actions::Update, path: 'admins/an-admin'
+    end
+
+    context "without an ID attribute" do
+      let(:params) { { name: 'An Admin' } }
+      it_should_behave_like Onfleet::Actions::Create, path: 'admins'
+    end
+  end
+
+  %i[id name email type metadata].each do |attr|
+    describe "##{attr}" do
+      subject { admin.public_send(attr) }
+      let(:params) { { attr => value } }
+      let(:value) { 'pizza' }
+      it { should == value }
+    end
+  end
+end
+