freshdesk_apiclient 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c67b2ccd83449bf610df65a9654726d8f34937aa
-  data.tar.gz: e3a070ed3e73a4c4938df9b29976201e3901d0ab
+  metadata.gz: 6429194a2b6efcbe4c6cad46d080fd2b16679a01
+  data.tar.gz: 948d6153138e7c8f1b2e887eae23e713de6c15a1
 SHA512:
-  metadata.gz: 4cfa44771737bb759ee954b6cd307b71e519df5e2f4caa8f793a7fbb40875b9c4423ff1cefc504043534ad9536caec3babafbd085c6ef23595c73f1dbae2ebbb
-  data.tar.gz: 9244b995840da35dfce94cde37379cc3f8ebf4f6e24d30423e6279bb8dc40a1c474fdbcfe65affdda30e7dcb5275185d3b791cd382790d63bbefb4cc941bb132
+  metadata.gz: aac732b4c3e702350e3afecbc2b1227212857750b967115a86cda6e72bf00155e4efe4daea82d21ff14407363e55225d7591b3f11643346a9c2226a6106497cc
+  data.tar.gz: 97e3e57d0922e6afe2c007eadd7040c4534be4f1c2dfdc386bd32f55fccb4dcd0ec858bde172a745b6ce0d8bb952a0b6982ca40734d8986e8e68f11502b233d7

data/.codeclimate.yml

@@ -12,10 +12,12 @@ engines:
     config:
       languages:
       - ruby
+  flog:
+    enabled: false
 ratings:
   paths:
   - lib/**
   - "**.rb"
 exclude_paths:
 - spec/**/*
-- "**/vendor/**/*"
+- "**/vendor/**/*"

data/.rubocop.yml

@@ -143,7 +143,7 @@ Style/StringLiteralsInInterpolation:
 Metrics/AbcSize:
   Description: A calculated magnitude based on number of assignments, branches, and
     conditions.
-  Enabled: false
+  Enabled: true
   Max: 15
 Metrics/BlockLength:
   ExcludedMethods: ['describe', 'context', 'shared_examples']

data/.travis.yml

@@ -15,4 +15,4 @@ addons:
   code_climate:
     repo_token: c10c2e0f19f128e1104891ce01b180b0f226ee1c58ba42a1bda3cfa0c7a2784d
 after_success:
-  - bundle exec codeclimate-test-reporter
+  - bundle exec codeclimate-test-reporter

data/README.md

@@ -8,7 +8,7 @@
 [![Dependency Status](https://gemnasium.com/badges/github.com/qbantek/freshdesk_apiclient.svg)](https://gemnasium.com/github.com/qbantek/freshdesk_apiclient)
 [![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://freshdesk_apiclient.mit-license.org)
 
-A ruby client for [freshdesk.com](https://developer.freshdesk.com/api/) API.
+A ruby client for [freshdesk](https://developer.freshdesk.com/api/) API.
 
 ## Installation
 
@@ -25,20 +25,73 @@ And then execute:
 Or install it yourself as:
 
     $ gem install freshdesk_apiclient
+    
+#### Setup your authentication credentials    
+    
+You'll need to create your account and get the credentials at [freshdesk](https://freshdesk.com/). 
+See [Authentication](https://developers.freshdesk.com/api/#authentication) for more information.
+
+Username and password:
+
+```ruby
+# config/initializers/freshdesk_apiclient.rb
+FreshdeskApiclient.username_or_api_key = ENV["FRESHDESK_USERNAME"]
+FreshdeskApiclient.password = ENV["FRESHDESK_PASWWORD"]
+```
+
+Or API key:
+
+```ruby
+# config/initializers/freshdesk_apiclient.rb
+FreshdeskApiclient.username_or_api_key = ENV["FRESHDESK_API_KEY"]
+```
+(If you use the API key, there is no need for a password.)  
+  
+#### Other configuration
+  
+You might want to set the Logger to be used by the gem.
+  
+```ruby
+# config/initializers/freshdesk_apiclient.rb
+FreshdeskApiclient.logger = Rails.logger
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Currently, only the following requests are supported:
+
+#### Tickets
+
+- Create a ticket
+
+```ruby
+client = FreshdeskApiclient::Client.new
+client.tickets.create payload   # payload is a hash, 
+```
+See [Create a ticket](https://developers.freshdesk.com/api/#create_ticket) for allowed attributes on the payload.
+
+- List all tickets
+
+```ruby
+client = FreshdeskApiclient::Client.new
+client.tickets.list
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec spec` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. 
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, 
+which will create a git tag for the version, push git commits and tags, 
+and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/qbantek/freshdesk_apiclient. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/qbantek/freshdesk_apiclient. 
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere 
+to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/core_extensions/object/class_name.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module ObjectExtensions
+  refine Object do
+    def class_name
+      full_class_name_as_array.last
+    end
+
+    def full_class_name_as_array
+      full_class_name.split('::')
+    end
+
+    def full_class_name
+      self.class.name
+    end
+  end
+end

data/lib/freshdesk_apiclient/rest/client.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require_relative '../../../lib/freshdesk_apiclient'
+
 module FreshdeskApiclient
   module REST
     class Client
@@ -13,8 +15,7 @@ module FreshdeskApiclient
       # @param [Logger] logger
       def initialize(domain: FreshdeskApiclient.domain,
                      username_or_api_key: FreshdeskApiclient.username_or_api_key,
-                     password: FreshdeskApiclient.password,
-                     logger: nil)
+                     password: FreshdeskApiclient.password, logger: FreshdeskApiclient.logger)
         @base_url = "https://#{domain}.freshdesk.com/api/v2/"
         @credentials = {username: username_or_api_key, password: password}
         @logger = logger
@@ -22,21 +23,41 @@ module FreshdeskApiclient
 
       # obj.method_missing(symbol [, *args] )   -> result
       def method_missing(symbol, *arguments, &block)
-        if RESOURCES.include? symbol
-          class_name = camelize(symbol.to_s)
-          variable = "@#{class_name.downcase}"
-          unless instance_variable_defined? variable
-            klass = Object.const_get('FreshdeskApiclient').const_get('REST').const_get class_name
-            instance_variable_set(variable, klass.new(@base_url, credentials: @credentials, logger: logger))
-          end
-          instance_variable_get(variable)
-        else
-          super
-        end
-      end
-
-      def respond_to_missing?(method_sym, include_private=false)
-        RESOURCES.include?(method_sym) ? true : super
+        RESOURCES.include?(symbol) ? instance_variable(symbol) : super
+      end
+
+      def respond_to_missing?(method, *)
+        RESOURCES.include?(method) ? true : super
+      end
+
+      private
+
+      def instance_variable(symbol)
+        class_name = camelize symbol
+        get_set_ivar class_name, as_ivar(class_name)
+      end
+
+      def get_set_ivar(class_name, ivar)
+        instance_variable_defined?(ivar) ? instance_variable_get(ivar) : set(ivar, class_name)
+      end
+
+      def set(ivar, class_name)
+        obj = instantiate class_name
+        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

data/lib/freshdesk_apiclient/rest/resources.rb

@@ -1,44 +1,55 @@
 # frozen_string_literal: true
 require 'rest-client'
 require 'forwardable'
-require 'base64'
+require_relative '../../../lib/core_extensions/object/class_name'
 
 module FreshdeskApiclient
   module REST
     class Resources
+      using ObjectExtensions
+
       def initialize(base_url, options={})
-        @options = {url: "#{base_url}/#{options[:path] || end_point}"}
-        @headers = headers options[:credentials]
+        @args = default_arguments options[:credentials], base_url, options[:path]
         RestClient.log = options[:logger]
       end
 
       def list
-        execute(method: :get, headers: @headers.dup.reject! {|key| [:'Content-Type'].include?(key) })
+        execute(method: :get, headers: headers)
       end
 
       def create(json_payload)
-        execute(method: :post, headers: @headers, payload: json_payload)
+        execute(method: :post, headers: content_headers, payload: json_payload)
       end
 
-      protected
+      private
 
-      def end_point
-        self.class.name.split('::').last.downcase
+      def resource
+        class_name.downcase
       end
 
-      private
-
-      def execute(options)
-        RestClient::Request.execute @options.merge(options)
+      def execute(args)
+        RestClient::Request.execute @args.merge(args)
       end
 
-      def headers(credentials)
+      def default_arguments(credentials, base_url, path=nil)
         {
-          Authorization: "Basic #{Base64.encode64("#{credentials[:username]}:#{credentials[:password]}")}",
-          'Content-Type': 'application/json',
-          Accept: 'application/json'
+          user: credentials[:username],
+          password: credentials[:password],
+          url: full_url(base_url, path)
         }
       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'}
+      end
     end
   end
 end

data/lib/freshdesk_apiclient/rest/tickets.rb

@@ -3,6 +3,7 @@ require_relative '../../../lib/freshdesk_apiclient/rest/resources' unless define
 
 module FreshdeskApiclient
   module REST
-    class Tickets < FreshdeskApiclient::REST::Resources; end
+    class Tickets < FreshdeskApiclient::REST::Resources
+    end
   end
 end

data/lib/freshdesk_apiclient/utils/camelizable.rb

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

data/lib/freshdesk_apiclient/version.rb

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

data/lib/freshdesk_apiclient.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'core_extensions/object/class_name'
 require 'freshdesk_apiclient/version'
 
 require 'freshdesk_apiclient/utils/loggeable'
@@ -32,4 +33,12 @@ module FreshdeskApiclient
   def self.password=(password)
     @password = password
   end
+
+  def self.logger
+    @logger ||= nil
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
 end

data/spec/core_extensions/object/class_name_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require_relative '../../../lib/core_extensions/object/class_name'
+RSpec.describe ObjectExtensions do
+  module Foo
+    class Bar
+    end
+  end
+
+  context 'when refining Object' do
+    using ObjectExtensions
+
+    context 'for any Foo:Bar instance' do
+      subject { Foo::Bar.new }
+      describe '#full_class_name' do
+        it { expect(subject.full_class_name).to eq('Foo::Bar') }
+      end
+
+      describe '#full_class_name_as_array' do
+        it('should return an Array of 2 items') do
+          expect(subject.full_class_name_as_array).to be_a(Array)
+          expect(subject.full_class_name_as_array.size).to eq(2)
+        end
+        it('first array item should eq Foo') { expect(subject.full_class_name_as_array[0]).to eq('Foo') }
+        it('second array item should eq Bar') { expect(subject.full_class_name_as_array[0]).to eq('Foo') }
+      end
+
+      describe '#class_name' do
+        it { expect(subject.class_name).to eq('Bar') }
+      end
+    end
+  end
+end

data/spec/freshdesk_apiclient_spec.rb

@@ -17,4 +17,7 @@ RSpec.describe FreshdeskApiclient do
     before { FreshdeskApiclient.password = nil }
     it('has a default password') { expect(FreshdeskApiclient.password).to eq('X') }
   end
+
+  before { FreshdeskApiclient.logger = :l }
+  it('allows to set logger') { expect(FreshdeskApiclient.logger).to eq(:l) }
 end

data/spec/rest/client_spec.rb

@@ -37,6 +37,7 @@ describe FreshdeskApiclient::REST::Client do
     end
 
     context 'when a logger option is not provided' do
+      before { FreshdeskApiclient.logger = nil }
       it('does not sets the logger') { expect(subject.instance_variable_get(:@logger)).to be_nil }
     end
 

data/spec/rest/resources_spec.rb

@@ -5,45 +5,36 @@ RSpec.describe FreshdeskApiclient::REST::Resources do
   subject { FreshdeskApiclient::REST::Resources.new(:url, credentials: {username: :u, password: :p}) }
 
   RSpec.shared_examples 'a resource' do
-    let(:get_headers) { {Authorization: "Basic dTpw\n", Accept: 'application/json'} }
+    let(:get_headers) { {Accept: 'application/json'} }
     let(:post_headers) { get_headers.merge('Content-Type': 'application/json') }
     let(:resource) { subject.class.name.split('::').last.downcase }
 
     describe '#new' do
+      it 'sets the user using given credentials' do
+        expect(subject.instance_variable_get(:@args)[: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(:@options)[:url]).to eql("#{:url}/#{:foo}")
+          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(:@options)[:url]).to eql("#{:url}/#{resource}")
+          expect(subject.instance_variable_get(:@args)[:url]).to eql("#{:url}/#{resource}")
         end
       end
 
-      it 'sets the Authorization header for the given credentials' do
-        expect(subject.instance_variable_get(:@headers)[:Authorization]).to eql(get_headers[:Authorization])
-      end
-
-      it 'sets the Accept header to accept JSON' do
-        expect(subject.instance_variable_get(:@headers)[:Accept]).to eql(get_headers[:Accept])
-      end
-
-      it 'sets the Content-Type header to indicate JSON content' do
-        expect(subject.instance_variable_get(:@headers)[:'Content-Type']).to eql(post_headers[:'Content-Type'])
-      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: {username: :u, password: :p}, logger: logger)
         expect(rest_client).to have_received(:log=).with(logger)
       end
     end
@@ -52,7 +43,14 @@ RSpec.describe FreshdeskApiclient::REST::Resources do
       it('executes the request as a GET') do
         request = object_double('RestClient::Request', execute: nil).as_stubbed_const
         subject.list
-        expect(request).to have_received(:execute).with(method: :get, url: "#{:url}/#{resource}", headers: get_headers)
+        expect(request).to have_received(:execute).with(hash_including(method: :get))
+      end
+
+      it 'sets the Accept header to accept JSON' do
+        request = object_double('RestClient::Request', execute: nil).as_stubbed_const
+        subject.list
+        expect(get_headers[:Accept]).to eq('application/json')
+        expect(request).to have_received(:execute).with(hash_including(headers: get_headers))
       end
     end
 
@@ -60,10 +58,26 @@ RSpec.describe FreshdeskApiclient::REST::Resources do
       it('executes the request as a POST') do
         request = object_double('RestClient::Request', execute: nil).as_stubbed_const
         subject.create :payload
-        expect(request).to have_received(:execute).with(method: :post,
-                                                        url: "#{:url}/#{resource}",
-                                                        headers: post_headers,
-                                                        payload: :payload)
+        expect(request).to have_received(:execute).with(hash_including(method: :post))
+      end
+
+      it 'sets the Accept header to accept JSON' do
+        request = object_double('RestClient::Request', execute: nil).as_stubbed_const
+        subject.create :payload
+        expect(request).to have_received(:execute).with(hash_including(headers: post_headers))
+      end
+
+      it 'sets the Content-Type header to indicate JSON content' do
+        request = object_double('RestClient::Request', execute: nil).as_stubbed_const
+        subject.create :payload
+        expect(post_headers[:'Content-Type']).to eq('application/json')
+        expect(request).to have_received(:execute).with(hash_including(headers: post_headers))
+      end
+
+      it 'submits the payload' do
+        request = object_double('RestClient::Request', execute: nil).as_stubbed_const
+        subject.create :payload
+        expect(request).to have_received(:execute).with(hash_including(payload: :payload))
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freshdesk_apiclient
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -194,6 +194,7 @@ files:
 - bin/console
 - bin/setup
 - freshdesk_apiclient.gemspec
+- lib/core_extensions/object/class_name.rb
 - lib/freshdesk_apiclient.rb
 - lib/freshdesk_apiclient/rest/client.rb
 - lib/freshdesk_apiclient/rest/resources.rb
@@ -202,6 +203,7 @@ files:
 - lib/freshdesk_apiclient/utils/loggeable.rb
 - lib/freshdesk_apiclient/version.rb
 - lib/tasks/releaser.rake
+- spec/core_extensions/object/class_name_spec.rb
 - spec/freshdesk_apiclient_spec.rb
 - spec/rest/client_spec.rb
 - spec/rest/resources_spec.rb
@@ -237,3 +239,4 @@ test_files:
 - spec/rest/resources_spec.rb
 - spec/freshdesk_apiclient_spec.rb
 - spec/spec_helper.rb
+- spec/core_extensions/object/class_name_spec.rb