Cleanup and refactor code. Remove specs

mattapayne · mattapayne · commit f42c7519193e · 2018-05-21T10:19:37.000-07:00
diff --git a/lib/config.rb b/lib/config.rb
@@ -2,6 +2,13 @@ module FreshdeskApiV2
   class Config
     attr_accessor :domain, :api_key, :username, :password
 
+    def initialize(hash = {})
+      @domain = hash[:domain]
+      @api_key = hash[:api_key]
+      @username = hash[:username]
+      @password = hash[:password]
+    end
+
     def validate!
       validate_domain!
       validate_credentials!
@@ -10,9 +17,7 @@ def validate!
     private
 
       def validate_domain!
-        if domain.nil? || domain.to_s.length == 0
-          raise ConfigurationException, 'Domain is required.'
-        end
+        raise ConfigurationException, 'Domain is required.' if domain.nil? || domain.to_s.length == 0
       end
 
       def validate_credentials!
diff --git a/lib/freshdesk_api_v2.rb b/lib/freshdesk_api_v2.rb
@@ -6,9 +6,11 @@
 require 'uri'
 require 'cgi'
 require 'json'
+require 'freshdesk_api_v2/exceptions'
 require 'freshdesk_api_v2/search_args'
 require 'freshdesk_api_v2/utils'
-require 'freshdesk_api_v2/entity'
+require 'freshdesk_api_v2/base'
+require 'freshdesk_api_v2/list_only_base'
 require 'freshdesk_api_v2/contacts'
 require 'freshdesk_api_v2/companies'
 require 'freshdesk_api_v2/contact_fields'
@@ -17,20 +19,6 @@
 require 'freshdesk_api_v2/client'
 
 module FreshdeskApiV2
-  class ConfigurationException < StandardError; end
-  class PaginationException < StandardError; end
-  class SearchException < StandardError; end
-  class CreationException < StandardError; end
-  class UpdateException < StandardError; end
-
-  class InvalidSearchException < StandardError
-    attr_reader :errors
-    def initialize(error_description, errors)
-      super(error_description)
-      @errors = errors
-    end
-  end
-
   def self.configure(&block)
     @config = Config.new
     block.call(@config)
diff --git a/lib/freshdesk_api_v2/base.rb b/lib/freshdesk_api_v2/base.rb
@@ -1,5 +1,5 @@
 module FreshdeskApiV2
-  class Entity
+  class Base
     def initialize(http)
       @http = http
     end
@@ -29,11 +29,13 @@ def show(id)
 
     def create(attributes)
       validate_create_attributes!(attributes)
+      attributes = prepare_attributes!(attributes)
       http_create(attributes)
     end
 
     def update(id, attributes)
       validate_update_attributes!(attributes)
+      attributes = prepare_attributes!(attributes)
       http_update(id, attributes)
     end
 
@@ -62,6 +64,16 @@ def validate_pagination!(first_page, last_page)
         raise PaginationException, 'last_page must be a number greater than or equal to first_page' if last_page.to_i < first_page.to_i
       end
 
+      def prepare_attributes!(attributes)
+        clean = attributes.reject { |key, value | !allowed_attributes.include?(key) || value.nil? }
+        custom_fields = clean['custom_fields']
+        if !custom_fields.nil? && custom_fields.any?
+          custom_fields = custom_fields.reject { |_, value| value.nil? }
+          clean['custom_fields'] = custom_fields if !custom_fields.nil? && custom_fields.any?
+        end
+        clean
+      end
+
     private
 
       def http_show(id)
@@ -76,7 +88,7 @@ def http_create(attributes)
 
       def http_destroy(id)
         response = @http.delete("#{api_url}/#{id}")
-        response.code
+        response.status
       end
 
       def http_update(id, attributes)
diff --git a/lib/freshdesk_api_v2/client.rb b/lib/freshdesk_api_v2/client.rb
@@ -1,9 +1,16 @@
 module FreshdeskApiV2
   class Client
+    attr_reader :configuration
+
     def initialize(configuration = nil)
-      configuration = FreshdeskApiV2.configuration if configuration.nil?
-      configuration.validate!
-      @http = Http.new(configuration)
+      if !configuration.nil?
+        @configuration = Config.new(configuration) if configuration.is_a?(Hash)
+        @configuration = configuration if configuration.is_a?(FreshdeskApiV2::Config)
+      else
+        @configuration = FreshdeskApiV2.configuration
+      end
+      @configuration.validate!
+      @http = Http.new(@configuration)
     end
 
     def contacts
diff --git a/lib/freshdesk_api_v2/companies.rb b/lib/freshdesk_api_v2/companies.rb
@@ -1,9 +1,25 @@
 module FreshdeskApiV2
-  class Companies < Entity
+  class Companies < Base
+    ALLOWED_ATTRIBUTES = %w[
+      custom_fields
+      description
+      domains
+      name
+      note
+      health_score
+      account_tier
+      renewal_date
+      industry
+    ].freeze
+
     protected
 
       def endpoint
         'companies'
       end
+
+      def allowed_attributes
+        ALLOWED_ATTRIBUTES
+      end
   end
 end
diff --git a/lib/freshdesk_api_v2/company_fields.rb b/lib/freshdesk_api_v2/company_fields.rb
@@ -1,5 +1,5 @@
 module FreshdeskApiV2
-  class CompanyFields < Entity
+  class CompanyFields < ListOnlyBase
     protected
 
       def endpoint
diff --git a/lib/freshdesk_api_v2/contact_fields.rb b/lib/freshdesk_api_v2/contact_fields.rb
@@ -1,5 +1,5 @@
 module FreshdeskApiV2
-  class ContactFields < Entity
+  class ContactFields < ListOnlyBase
     protected
 
       def endpoint
diff --git a/lib/freshdesk_api_v2/contacts.rb b/lib/freshdesk_api_v2/contacts.rb
@@ -1,9 +1,33 @@
 module FreshdeskApiV2
-  class Contacts < Entity
+  class Contacts < Base
+    ALLOWED_ATTRIBUTES = [
+      :name,
+      :phone,
+      :email,
+      :mobile,
+      :twitter_id,
+      :unique_external_id,
+      :other_emails,
+      :company_id,
+      :view_all_tickets,
+      :other_companies,
+      :address,
+      :avatar,
+      :custom_fields,
+      :description,
+      :job_title,
+      :tags,
+      :timezone
+    ].freeze
+
     protected
 
       def endpoint
         'contacts'
       end
+
+      def allowed_attributes
+        ALLOWED_ATTRIBUTES
+      end
   end
 end
diff --git a/lib/freshdesk_api_v2/exceptions.rb b/lib/freshdesk_api_v2/exceptions.rb
@@ -0,0 +1,15 @@
+module FreshdeskApiV2
+  class ConfigurationException < StandardError; end
+  class PaginationException < StandardError; end
+  class SearchException < StandardError; end
+  class CreationException < StandardError; end
+  class UpdateException < StandardError; end
+
+  class InvalidSearchException < StandardError
+    attr_reader :errors
+    def initialize(error_description, errors)
+      super(error_description)
+      @errors = errors
+    end
+  end
+end
diff --git a/lib/freshdesk_api_v2/http.rb b/lib/freshdesk_api_v2/http.rb
@@ -46,23 +46,23 @@ def paginate(url, last_page, collection = [])
     end
 
     def get(url)
-      res = construct_http_client(url, accept_headers)
+      res = construct_http_client(url)
       res.get
     end
 
     def delete(url)
-      res = construct_http_client(url, accept_headers)
+      res = construct_http_client(url)
       res.delete
     end
 
     def put(url, attributes)
-      res = construct_http_client(url, content_type_headers)
-      res.put(attributes.to_json)
+      res = construct_http_client(url)
+      res.put(body: attributes.to_json)
     end
 
     def post(url, attributes)
-      res = construct_http_client(url, content_type_headers)
-      res.post(attributes.to_json)
+      res = construct_http_client(url)
+      res.post(body: attributes.to_json)
     end
 
     def domain
@@ -93,12 +93,11 @@ def next_page(url)
         url[Utils::PAGE_REGEX, 1]
       end
 
-      def accept_headers
-        { accept: 'application/json' }
-      end
-
-      def content_type_headers
-        { content_type: 'application/json' }
+      def headers
+        {
+          'Accept' => 'application/json',
+          'Content-Type' => 'application/json'
+        }
       end
 
       def password_or_x
@@ -117,7 +116,7 @@ def username_or_api_key
         end
       end
 
-      def construct_http_client(url, headers)
+      def construct_http_client(url)
         Excon.new(url,
           uri_parser: Addressable::URI,
           headers: headers,
diff --git a/lib/freshdesk_api_v2/list_only_base.rb b/lib/freshdesk_api_v2/list_only_base.rb
@@ -0,0 +1,29 @@
+module FreshdeskApiV2
+  class ListOnlyBase
+    def initialize(http)
+      @http = http
+    end
+
+    def list
+      response = @http.get(api_url)
+      JSON.parse(response.body)
+    end
+
+    protected
+
+      # This method should be overridden in derived classes
+      def endpoint
+        raise StandardError, 'Please implement this method.'
+      end
+
+    private
+
+      def base_api_url
+        "https://#{@http.domain}.freshdesk.com/api/v2"
+      end
+
+      def api_url
+        "#{base_api_url}/#{endpoint}"
+      end
+  end
+end
diff --git a/spec/freshdesk_api_v2/base_spec.rb b/spec/freshdesk_api_v2/base_spec.rb
@@ -0,0 +1,3 @@
+RSpec.describe FreshdeskApiV2::Base do
+
+end
diff --git a/spec/freshdesk_api_v2/client_spec.rb b/spec/freshdesk_api_v2/client_spec.rb
@@ -1,27 +1,40 @@
 RSpec.describe FreshdeskApiV2::Client do
-  let(:api_key) { 'key' }
-  let(:domain) { 'test-domain' }
+  subject do
+    FreshdeskApiV2::Client.new
+  end
 
-  before do
-    FreshdeskApiV2.configure do |conf|
-      conf.domain = domain
-      conf.api_key = api_key
-    end
+  it 'can be constructed from defaults' do
+    client = FreshdeskApiV2::Client.new
+    expect(client.configuration.domain).to eq(FreshdeskApiV2.configuration.domain)
+    expect(client.configuration.api_key).to eq(FreshdeskApiV2.configuration.api_key)
   end
 
-  after do
-    FreshdeskApiV2.reset_configuration!
+  it 'can be constructed from a hash of settings' do
+    client = FreshdeskApiV2::Client.new(domain: 'domain', api_key: 'api_key')
+    expect(client.configuration.domain).to eq('domain')
+    expect(client.configuration.api_key).to eq('api_key')
   end
 
-  subject do
-    FreshdeskApiV2::Client.new
+  it 'can be constructed from a FreshdeskApiV2::Config object' do
+    config = FreshdeskApiV2::Config.new(domain: 'domain', api_key: 'api_key')
+    client = FreshdeskApiV2::Client.new(config)
+    expect(client.configuration.domain).to eq('domain')
+    expect(client.configuration.api_key).to eq('api_key')
   end
 
-  it 'responds to the contacts with a Contacts object' do
+  it 'responds to contacts with a Contacts object' do
     expect(subject.contacts).to be_instance_of(FreshdeskApiV2::Contacts)
   end
 
-  it 'responds to the companies with a Companies object' do
+  it 'responds to companies with a Companies object' do
     expect(subject.companies).to be_instance_of(FreshdeskApiV2::Companies)
   end
+
+  it 'responds to contact_fields with a ContactFields object' do
+    expect(subject.contact_fields).to be_instance_of(FreshdeskApiV2::ContactFields)
+  end
+
+  it 'responds to the company_fields with a CompanyFields object' do
+    expect(subject.company_fields).to be_instance_of(FreshdeskApiV2::CompanyFields)
+  end
 end
diff --git a/spec/freshdesk_api_v2/companies_spec.rb b/spec/freshdesk_api_v2/companies_spec.rb
@@ -1,3 +1,3 @@
 RSpec.describe FreshdeskApiV2::Companies do
-  # Nothing to test here!
+  #Nothing to test here
 end
diff --git a/spec/freshdesk_api_v2/company_fields_spec.rb b/spec/freshdesk_api_v2/company_fields_spec.rb
@@ -0,0 +1,11 @@
+RSpec.describe FreshdeskApiV2::CompanyFields do
+  subject do
+    client = FreshdeskApiV2::Client.new
+    client.company_fields
+  end
+
+  context 'list' do
+
+  end
+
+end
diff --git a/spec/freshdesk_api_v2/contact_fields_spec.rb b/spec/freshdesk_api_v2/contact_fields_spec.rb
@@ -0,0 +1,11 @@
+RSpec.describe FreshdeskApiV2::ContactFields do
+  subject do
+    client = FreshdeskApiV2::Client.new
+    client.contact_fields
+  end
+
+  context 'list' do
+
+  end
+
+end
diff --git a/spec/freshdesk_api_v2/contacts_spec.rb b/spec/freshdesk_api_v2/contacts_spec.rb
@@ -1,3 +1,3 @@
 RSpec.describe FreshdeskApiV2::Contacts do
-  # Nothing to test here!
+  #Nothing to test here
 end
diff --git a/spec/freshdesk_api_v2/entity_spec.rb b/spec/freshdesk_api_v2/entity_spec.rb
diff --git a/spec/freshdesk_api_v2_spec.rb b/spec/freshdesk_api_v2_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
