freshdesk_apiclient 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6429194a2b6efcbe4c6cad46d080fd2b16679a01
-  data.tar.gz: 948d6153138e7c8f1b2e887eae23e713de6c15a1
+  metadata.gz: 8d85fb8c558f75d5c5d8864830f14d2f09f6dae2
+  data.tar.gz: 0210f1247735236bf4c0b3d0abc325f45a0be929
 SHA512:
-  metadata.gz: aac732b4c3e702350e3afecbc2b1227212857750b967115a86cda6e72bf00155e4efe4daea82d21ff14407363e55225d7591b3f11643346a9c2226a6106497cc
-  data.tar.gz: 97e3e57d0922e6afe2c007eadd7040c4534be4f1c2dfdc386bd32f55fccb4dcd0ec858bde172a745b6ce0d8bb952a0b6982ca40734d8986e8e68f11502b233d7
+  metadata.gz: a4fe7698d8b7e506a41c07b4055acce08b4dabcb59daf68017b6bb7be5a2968d4963715737095beb61177c9578a3abf71d74ac326ef3372397133d598fc6d453
+  data.tar.gz: 252ba08dd746574322b780c596afc7ab0fc85bbfa9f00cf013de238594fc5c09ec5783f89f24e52ee5eea5af0ddcc3f38a9443d181fb51e99a0752e47c0d2786

data/lib/core_extensions/object/class_name.rb

@@ -5,6 +5,10 @@ module ObjectExtensions
       full_class_name_as_array.last
     end
 
+    def namespace_as_array
+      full_class_name_as_array[0...-1]
+    end
+
     def full_class_name_as_array
       full_class_name.split('::')
     end

data/lib/freshdesk_apiclient.rb

@@ -5,6 +5,7 @@ require 'freshdesk_apiclient/version'
 require 'freshdesk_apiclient/utils/loggeable'
 require 'freshdesk_apiclient/utils/camelizable'
 
+require 'freshdesk_apiclient/rest/model_factory'
 require 'freshdesk_apiclient/rest/resources'
 require 'freshdesk_apiclient/rest/tickets'
 require 'freshdesk_apiclient/rest/client'

data/lib/freshdesk_apiclient/rest/client.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 require_relative '../../../lib/freshdesk_apiclient'
+require_relative '../../../lib/freshdesk_apiclient/rest/model_factory'
+require_relative '../../../lib/freshdesk_apiclient/utils/camelizable'
 
 module FreshdeskApiclient
   module REST
     class Client
       include FreshdeskApiclient::Utils::Loggeable
-      include FreshdeskApiclient::Utils::Camelizable
 
       RESOURCES = %i(tickets).freeze
 
@@ -17,7 +18,7 @@ module FreshdeskApiclient
                      username_or_api_key: FreshdeskApiclient.username_or_api_key,
                      password: FreshdeskApiclient.password, logger: FreshdeskApiclient.logger)
         @base_url = "https://#{domain}.freshdesk.com/api/v2/"
-        @credentials = {username: username_or_api_key, password: password}
+        @credentials = {user: username_or_api_key, password: password}
         @logger = logger
       end
 
@@ -33,7 +34,7 @@ module FreshdeskApiclient
       private
 
       def instance_variable(symbol)
-        class_name = camelize symbol
+        class_name = FreshdeskApiclient::Utils::Camelizable.camelize symbol
         get_set_ivar class_name, as_ivar(class_name)
       end
 
@@ -42,23 +43,13 @@ module FreshdeskApiclient
       end
 
       def set(ivar, class_name)
-        obj = instantiate class_name
+        obj = ModelFactory.new.instantiate class_name, @base_url, credentials: @credentials, logger: logger
         instance_variable_set ivar, obj
       end
 
       def as_ivar(name)
         "@#{name.downcase}"
       end
-
-      def instantiate(class_name)
-        klass(class_name, 'FreshdeskApiclient', 'REST').new(@base_url, credentials: @credentials, logger: logger)
-      end
-
-      def klass(class_name, *module_names)
-        c = Object
-        module_names.each {|m| c = c.const_get m }
-        c.const_get class_name
-      end
     end
   end
 end

data/lib/freshdesk_apiclient/rest/model_factory.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require_relative '../../../lib/core_extensions/object/class_name'
+
+module FreshdeskApiclient
+  module REST
+    class ModelFactory
+      using ObjectExtensions
+
+      def instantiate(class_name, *args)
+        klass(class_name).new(*args)
+      end
+
+      def klass(class_name)
+        ancestor.const_get class_name
+      end
+
+      def ancestor
+        c = Object
+        namespace_as_array.each {|m| c = c.const_get m }
+        c
+      end
+    end
+  end
+end

data/lib/freshdesk_apiclient/rest/resources.rb

@@ -8,47 +8,37 @@ module FreshdeskApiclient
     class Resources
       using ObjectExtensions
 
+      ACCEPT_HEADER = {Accept: 'application/json'}.freeze
+      ACCEPT_AND_CONTENT_HEADERS = ACCEPT_HEADER.merge('Content-Type': 'application/json')
+
       def initialize(base_url, options={})
-        @args = default_arguments options[:credentials], base_url, options[:path]
+        @base_url = base_url
+        @credentials = options[:credentials]
         RestClient.log = options[:logger]
       end
 
-      def list
-        execute(method: :get, headers: headers)
+      def list(path=nil)
+        url = full_url path
+        execute(url: url, method: :get, headers: ACCEPT_HEADER)
       end
 
       def create(json_payload)
-        execute(method: :post, headers: content_headers, payload: json_payload)
+        url = full_url
+        execute(url: url, method: :post, headers: ACCEPT_AND_CONTENT_HEADERS, payload: json_payload)
       end
 
       private
 
-      def resource
-        class_name.downcase
-      end
-
       def execute(args)
-        RestClient::Request.execute @args.merge(args)
+        RestClient::Request.execute @credentials.merge(args)
       end
 
-      def default_arguments(credentials, base_url, path=nil)
-        {
-          user: credentials[:username],
-          password: credentials[:password],
-          url: full_url(base_url, path)
-        }
+      def full_url(path=nil)
+        "#{@base_url}/#{path || resource}"
       end
 
-      def full_url(base_url, path)
-        "#{base_url}/#{path || resource}"
-      end
-
-      def content_headers
-        headers.merge('Content-Type': 'application/json')
-      end
-
-      def headers
-        {Accept: 'application/json'}
+      def resource
+        class_name.downcase
       end
     end
   end

data/lib/freshdesk_apiclient/utils/camelizable.rb

@@ -2,12 +2,12 @@
 module FreshdeskApiclient
   module Utils
     module Camelizable
-      def camelize(term)
+      def self.camelize(term)
         string = term.to_s
         format string
       end
 
-      def format(string)
+      def self.format(string)
         string = string.sub(/^[a-z\d]*/) { $&.capitalize }
         string.gsub!(%r{(?:_|(/))([a-z\d]*)}) { $2.capitalize }
         string

data/lib/freshdesk_apiclient/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module FreshdeskApiclient
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/spec/core_extensions/object/class_name_spec.rb

@@ -27,6 +27,14 @@ RSpec.describe ObjectExtensions do
       describe '#class_name' do
         it { expect(subject.class_name).to eq('Bar') }
       end
+
+      describe '#namespace_as_array' do
+        it('should return an Array of 1 item') do
+          expect(subject.namespace_as_array).to be_a(Array)
+          expect(subject.namespace_as_array.size).to eq(1)
+        end
+        it('first array item should eq Foo') { expect(subject.namespace_as_array[0]).to eq('Foo') }
+      end
     end
   end
 end

data/spec/rest/client_spec.rb

@@ -23,7 +23,7 @@ describe FreshdeskApiclient::REST::Client do
       before { FreshdeskApiclient.password = :password }
       subject { FreshdeskApiclient::REST::Client.new }
       it 'sets the credentials for the given parameters' do
-        expect(subject.instance_variable_get(:@credentials)[:username]).to eq(:api_key)
+        expect(subject.instance_variable_get(:@credentials)[:user]).to eq(:api_key)
         expect(subject.instance_variable_get(:@credentials)[:password]).to eq(:password)
       end
     end
@@ -31,7 +31,7 @@ describe FreshdeskApiclient::REST::Client do
     context 'when password is not provided' do
       before { FreshdeskApiclient.password = nil }
       it 'sets the credentials for the given api_key and default password' do
-        expect(subject.instance_variable_get(:@credentials)[:username]).to eq(:api_key)
+        expect(subject.instance_variable_get(:@credentials)[:user]).to eq(:api_key)
         expect(subject.instance_variable_get(:@credentials)[:password]).to eq('X')
       end
     end
@@ -52,7 +52,8 @@ describe FreshdeskApiclient::REST::Client do
 
     describe "##{method}" do
       it do
-        klass = Object.const_get('FreshdeskApiclient').const_get('REST').const_get subject.camelize(method.to_s)
+        class_name = FreshdeskApiclient::Utils::Camelizable.camelize method.to_s
+        klass = Object.const_get('FreshdeskApiclient').const_get('REST').const_get class_name
         expect(subject.send(method)).to be_an_instance_of(klass)
       end
     end

data/spec/rest/model_factory_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+RSpec.describe FreshdeskApiclient::REST::ModelFactory do
+  describe '#instantiate' do
+    it 'returns an instance of the class' do
+      expect(subject.instantiate(:Array)).to be_a(Array)
+    end
+    it 'passes the arguments to the class constructor' do
+      expect(subject.instantiate(:Array, 1, true).size).to eq(1)
+      expect(subject.instantiate(:Array, 1, true).first).to eq(true)
+    end
+  end
+
+  describe '#klass' do
+    it 'returns a class' do
+      expect(subject.klass(:Array)).to be_a(Class)
+    end
+  end
+
+  describe '#ancestor' do
+    it 'returns the parent module (namespace)' do
+      expect(subject.ancestor).to eq(FreshdeskApiclient::REST)
+    end
+  end
+end

data/spec/rest/resources_spec.rb

@@ -2,7 +2,7 @@
 require_relative '../../lib/freshdesk_apiclient/rest/resources' unless defined?(FreshdeskApiclient::REST::Resources)
 
 RSpec.describe FreshdeskApiclient::REST::Resources do
-  subject { FreshdeskApiclient::REST::Resources.new(:url, credentials: {username: :u, password: :p}) }
+  subject { FreshdeskApiclient::REST::Resources.new(:url, credentials: {user: :u, password: :p}) }
 
   RSpec.shared_examples 'a resource' do
     let(:get_headers) { {Accept: 'application/json'} }
@@ -11,30 +11,17 @@ RSpec.describe FreshdeskApiclient::REST::Resources do
 
     describe '#new' do
       it 'sets the user using given credentials' do
-        expect(subject.instance_variable_get(:@args)[:user]).to eql(:u)
+        expect(subject.instance_variable_get(:@credentials)[:user]).to eql(:u)
       end
 
       it 'sets the password using given credentials' do
-        expect(subject.instance_variable_get(:@args)[:password]).to eql(:p)
-      end
-
-      context 'when path option is provided' do
-        subject { FreshdeskApiclient::REST::Resources.new(:url, credentials: {username: :u, password: :p}, path: :foo) }
-        it 'sets the url using given path' do
-          expect(subject.instance_variable_get(:@args)[:url]).to eql("#{:url}/#{:foo}")
-        end
-      end
-
-      context 'when path option is not provided' do
-        it 'sets the url for the given resource' do
-          expect(subject.instance_variable_get(:@args)[:url]).to eql("#{:url}/#{resource}")
-        end
+        expect(subject.instance_variable_get(:@credentials)[:password]).to eql(:p)
       end
 
       it('sets the logger on RestClient') do
         rest_client = object_double('RestClient', :log= => nil).as_stubbed_const
         logger = Logger.new(STDOUT)
-        FreshdeskApiclient::REST::Resources.new(:url, credentials: {username: :u, password: :p}, logger: logger)
+        FreshdeskApiclient::REST::Resources.new(:url, credentials: {user: :u, password: :p}, logger: logger)
         expect(rest_client).to have_received(:log=).with(logger)
       end
     end
@@ -52,6 +39,22 @@ RSpec.describe FreshdeskApiclient::REST::Resources do
         expect(get_headers[:Accept]).to eq('application/json')
         expect(request).to have_received(:execute).with(hash_including(headers: get_headers))
       end
+
+      context 'when path option is provided' do
+        it 'sets the url using given path' do
+          request = object_double('RestClient::Request', execute: nil).as_stubbed_const
+          subject.list :path
+          expect(request).to have_received(:execute).with(hash_including(url: "url/#{:path}"))
+        end
+      end
+
+      context 'when path option is not provided' do
+        it 'sets the url for the given resource' do
+          request = object_double('RestClient::Request', execute: nil).as_stubbed_const
+          subject.list
+          expect(request).to have_received(:execute).with(hash_including(url: "url/#{resource}"))
+        end
+      end
     end
 
     describe '#create' do

data/spec/rest/tickets_spec.rb

@@ -4,7 +4,7 @@ require_relative '../../lib/freshdesk_apiclient/rest/resources' unless defined?(
 require_relative '../../lib/freshdesk_apiclient/rest/tickets' unless defined?(FreshdeskApiclient::REST::Tickets)
 
 describe FreshdeskApiclient::REST::Tickets do
-  subject { FreshdeskApiclient::REST::Tickets.new(:url, credentials: {username: :u, password: :p}) }
+  subject { FreshdeskApiclient::REST::Tickets.new(:url, credentials: {user: :u, password: :p}) }
 
   it_behaves_like 'a resource'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: freshdesk_apiclient
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Erich Quintero
@@ -197,6 +197,7 @@ files:
 - lib/core_extensions/object/class_name.rb
 - lib/freshdesk_apiclient.rb
 - lib/freshdesk_apiclient/rest/client.rb
+- lib/freshdesk_apiclient/rest/model_factory.rb
 - lib/freshdesk_apiclient/rest/resources.rb
 - lib/freshdesk_apiclient/rest/tickets.rb
 - lib/freshdesk_apiclient/utils/camelizable.rb
@@ -206,6 +207,7 @@ files:
 - spec/core_extensions/object/class_name_spec.rb
 - spec/freshdesk_apiclient_spec.rb
 - spec/rest/client_spec.rb
+- spec/rest/model_factory_spec.rb
 - spec/rest/resources_spec.rb
 - spec/rest/tickets_spec.rb
 - spec/spec_helper.rb
@@ -234,6 +236,7 @@ signing_key:
 specification_version: 4
 summary: A ruby API client for freshdesk.com.
 test_files:
+- spec/rest/model_factory_spec.rb
 - spec/rest/client_spec.rb
 - spec/rest/tickets_spec.rb
 - spec/rest/resources_spec.rb