freshdesk_api 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e84c830292ea35d36a93308a74cf108c07adfe99
-  data.tar.gz: f9d2687cd49c41ca9f80379fd3da67753f304e79
+SHA256:
+  metadata.gz: b1db7ae8bbc4c251226e0839c92fa12a6edbbbeada0d07953c542b9730ef05b7
+  data.tar.gz: 4a0f47520221e194a7d53c0320ee29381d0fa7b12b4691002aa9850cfefe1f60
 SHA512:
-  metadata.gz: 430dd9ea0c87538bd2b7ab947309d238f704dfcac07902244a9c6477f7809175ab12659d27cbf1112d320b7b8ed036989f6cb70a7fd95dc5892689cf1b88a5cb
-  data.tar.gz: 5708e0cb06d59ebcffbe7c6a178ed2ac02142f6d8577017826640438ae93560acad7b4ab350a6af9d221e6ab54fc0d599f97e93266eca99626e6cbc38d42e188
+  metadata.gz: 5c0d709f723a3b2dcb9edce68a8ae92daf3f1389f394cf4ac544708d75076ef9bb902a3b778e6074ff257a910092e58d40e702afa3d88d35be040062f1f90de4
+  data.tar.gz: 04e8d347c85a9dfcab6c2b8769f10858e91ffb32531ba55f9aff51c55f67a187395be238fba013441b0b84bd6215114f80b4fa773a7d84a4141d762365ceeb7e

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.4
+Metrics/MethodLength:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Style/MethodMissingSuper:
+  Enabled: false
+Style/MissingRespondToMissing:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false

data/.travis.yml

@@ -1,13 +1,11 @@
 language: ruby
-install:
-  - gem uninstall bundler
-  - gem install bundler
-before_script: bin/setup
-script: rspec
+before_install:
+  - gem update bundler
+  - bundle --version
+  - gem update --system
+  - gem --version
 rvm:
-  - 2.3.0
-  - 2.2.4
-  - 2.1.8
-  - 2.0.0
-  - jruby
-  - rbx-2
+  - 2.5.1
+  - 2.4.4
+  - jruby-head
+sudo: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in freshdesk_api.gemspec

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Anton Maminov
+Copyright (c) 2015-2018 Anton Maminov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -6,7 +6,7 @@
 
 A Ruby API client that interfaces with freshdesk.com web service. This client supports regular CRUD operation.
 
-Please see [API documentation](http://freshdesk.com/api) for more information.
+Please see [API documentation](https://developers.freshdesk.com/api/) for more information.
 
 As of now,it supports the following:
 
@@ -14,7 +14,6 @@ As of now,it supports the following:
 * Solution Folder
 * Solution Article
 
-
 To experiment with that code, run `bin/console` for an interactive prompt.
 
 ## Installation
@@ -106,7 +105,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-Copyright (c) 2015-2016 by Anton Maminov
+Copyright (c) 2015-2018 by Anton Maminov
 
 [travis_badge]: http://img.shields.io/travis/mamantoha/freshdesk_api_client_rb.svg?style=flat
 [travis]: https://travis-ci.org/mamantoha/freshdesk_api_client_rb

data/Rakefile

@@ -1,15 +1,13 @@
-require 'rake/testtask'
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
-begin
-  require 'rspec/core/rake_task'
-rescue LoadError
-end
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 if defined?(RSpec)
-  desc "Run specs"
-  RSpec::Core::RakeTask.new("spec") do |t|
-    t.pattern = "spec/core/**/*_spec.rb"
+  desc 'Run specs'
+  RSpec::Core::RakeTask.new('spec') do |t|
+    t.pattern = 'spec/core/**/*_spec.rb'
   end
 
   desc 'Default: run specs.'

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "freshdesk_api"
+require 'bundler/setup'
+require 'freshdesk_api'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "freshdesk_api"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/freshdesk_api.gemspec

@@ -1,32 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'freshdesk_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "freshdesk_api"
+  spec.name          = 'freshdesk_api'
   spec.version       = FreshdeskAPI::VERSION
-  spec.authors       = ["Anton Maminov"]
-  spec.email         = ["anton.linux@gmail.com"]
+  spec.authors       = ['Anton Maminov']
+  spec.email         = ['anton.linux@gmail.com']
 
-  spec.summary       = %q{Freshdesk REST API Client}
-  spec.description   = %q{Ruby wrapper for the REST API at http://freshdesk.com. Documentation at http://freshdesk.com/api.}
-  spec.homepage      = "https://github.com/mamantoha/freshdesk_api_client_rb"
+  spec.summary       = 'Freshdesk REST API Client'
+  spec.description   = 'Ruby wrapper for the REST API at http://freshdesk.com. Documentation at http://freshdesk.com/api.'
+  spec.homepage      = 'https://github.com/mamantoha/freshdesk_api_client_rb'
 
-  spec.required_ruby_version     = ">= 2.0.0"
+  spec.required_ruby_version = '>= 2.4.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "activesupport"
-  spec.add_runtime_dependency "rest-client"
-  spec.add_runtime_dependency "multi_json"
-  spec.add_runtime_dependency "deep_merge"
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'deep_merge'
+  spec.add_runtime_dependency 'multi_json'
+  spec.add_runtime_dependency 'rest-client'
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "webmock", "~> 2.0"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'webmock'
 end

data/lib/freshdesk_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FreshdeskAPI; end
 
-require "freshdesk_api/client"
+require 'freshdesk_api/client'

data/lib/freshdesk_api/actions.rb

@@ -1,11 +1,11 @@
-module FreshdeskAPI
+# frozen_string_literal: true
 
+module FreshdeskAPI
   module ResponseHandler
     def handle_response(response)
       response = MultiJson.load(response, symbolize_keys: true)
-      if response[response_namespace]
-        @attributes.replace(@attributes.deep_merge(response[response_namespace]))
-      end
+      return unless response[response_namespace]
+      @attributes.replace(@attributes.deep_merge(response[response_namespace]))
     end
   end
 
@@ -34,7 +34,7 @@ module FreshdeskAPI
     # Finds, returning nil if it fails
     def find(client, options = {}, &block)
       find!(client, options, &block)
-    rescue FreshdeskAPI::Error::ClientError => e
+    rescue FreshdeskAPI::Error::ClientError
       nil
     end
   end
@@ -45,7 +45,7 @@ module FreshdeskAPI
     # If this resource hasn't been deleted, then create or save it.
     # Executes a POST if it is a {Data#new_record?}, otherwise a PUT.
     # @return [Resource] created or updated object
-    def save!(options = {})
+    def save!(_options = {})
       return false if respond_to?(:destroyed?) && destroyed?
 
       options = { request_namespace => attributes }
@@ -61,7 +61,7 @@ module FreshdeskAPI
       response = @client.make_request!(req_path, method, options)
 
       handle_response(response)
-      return self
+      self
     end
 
     # Saves, returning false if it fails and attachibg the errors
@@ -113,11 +113,11 @@ module FreshdeskAPI
 
     def update!(attributes = {})
       self.attributes.merge!(attributes)
-      self.save!
+      save!
     end
 
-    def update(attributes = {})
-      update!(attributes = {})
+    def update(attributes)
+      update!(attributes)
     rescue FreshdeskAPI::Error::ClientError
       false
     end
@@ -189,6 +189,5 @@ module FreshdeskAPI
         false
       end
     end
-
   end
 end

data/lib/freshdesk_api/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/string'
 require 'rest_client'
 require 'multi_json'
@@ -23,7 +25,7 @@ module FreshdeskAPI
 
     # Handles resources such as 'tickets'.
     # @return [Collection] Collection instance for resource
-    def method_missing(method, *args, &block)
+    def method_missing(method, *args)
       method = method.to_s
       method_class = method_as_class(method)
       options = args.last.is_a?(Hash) ? args.pop : {}
@@ -57,10 +59,11 @@ module FreshdeskAPI
 
     def make_request!(path, method, options = {})
       response = nil
-      connection[path].send(method, options) { |resp, req, result|
+      connection[path].send(method, options) do |resp, _req, _result|
         case resp.code
         when 302
           # Connection to the server failed. Please check username/password
+          raise Error::NotAcceptable
         when 404
           raise Error::ResourceNotFound
         when 406
@@ -69,10 +72,10 @@ module FreshdeskAPI
           raise Error::NetworkError
         end
         response = resp
-      }
-      return response
-    rescue Exception => e
-      raise Error::ClientError.new(e)
+      end
+      response
+    rescue StandardError => e
+      raise Error::ClientError, e
     end
 
     protected
@@ -93,22 +96,20 @@ module FreshdeskAPI
     private
 
     def method_as_class(method)
-      klass_as_string = ("FreshdeskAPI::" + method.to_s.singularize.classify).constantize
+      "FreshdeskAPI::#{method.to_s.singularize.classify}".constantize
     end
 
     def check_url
-      if !config.allow_http && config.base_url !~ /^https/
-        raise ArgumentError, "freshdesk_api is ssl only; url must begin with https://"
-      end
+      return unless !config.allow_http && config.base_url !~ /^https/
+      raise ArgumentError, 'freshdesk_api is ssl only; url must begin with https://'
     end
 
     def set_default_logger
-      if config.logger == true
-        require 'logger'
-        config.logger = Logger.new($stderr)
-        config.logger.level = Logger::WARN
-      end
-    end
+      return unless config.logger
 
+      require 'logger'
+      config.logger = Logger.new($stderr)
+      config.logger.level = Logger::WARN
+    end
   end
 end

data/lib/freshdesk_api/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FreshdeskAPI
   # Represents a collection of resources
   class Collection
@@ -14,7 +16,7 @@ module FreshdeskAPI
       @resource = resource.resource_name
       @options = options
 
-      methods = %w{ create find update destroy }
+      methods = %w[create find update destroy]
       methods += methods.map { |method| method + '!' }
       methods.each do |deferrable|
         # Passes arguments and the proper path to the resource class method.
@@ -28,7 +30,6 @@ module FreshdeskAPI
           @resource_class.send(deferrable, @client, opts)
         end
       end
-
     end
 
     # The API path to this collection
@@ -80,10 +81,7 @@ module FreshdeskAPI
         inspect << "options=#{@options.inspect}" if @options.any?
         "#{@resource.singularize} collection [#{inspect.join(',')}]"
       end
-
     end
-    alias :inspect :to_s
-
+    alias inspect to_s
   end
-
 end

data/lib/freshdesk_api/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FreshdeskAPI
   # Holds the configuration options for the client and connection
   class Configuration

data/lib/freshdesk_api/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FreshdeskAPI
   module Error
     class ClientError < StandardError; end
@@ -10,13 +12,12 @@ module FreshdeskAPI
       end
 
       def to_s
-        "#{self.class.name}: #{@errors.to_s}"
+        "#{self.class.name}: #{@errors}"
       end
     end
 
     class NotAcceptable < ClientError; end
     class ResourceNotFound < ClientError; end
     class NetworkError < ClientError; end
-
   end
 end

data/lib/freshdesk_api/helpers.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module FreshdeskAPI
   # @private
   module Helpers
     def self.deep_hash_access(hash, path)
       path.split('/').each do |p|
-        if p.to_i.to_s == p
-          hash = hash[p.to_i]
-        else
-          hash = hash[p.to_s] || hash[p.to_sym]
-        end
+        hash = if p.to_i.to_s == p
+                 hash[p.to_i]
+               else
+                 hash[p.to_s] || hash[p.to_sym]
+               end
         break unless hash
       end
       hash

data/lib/freshdesk_api/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'freshdesk_api/actions'
 
 module FreshdeskAPI
@@ -12,8 +14,7 @@ module FreshdeskAPI
     class << self
       # The singular resource name taken from the class name (e.g. FreshdeskAPI::SoulutionCategory -> solution_category)
       def singular_resource_name
-        @singular_respurce_name ||= to_s.split('::').last.underscore
-
+        @singular_resource_name ||= to_s.split('::').last.underscore
       end
 
       # The resource name taken from the class name (e.g. FreshdeskAPI::SolutionCatogory -> solution_categories)
@@ -45,7 +46,6 @@ module FreshdeskAPI
     def to_s
       "#{self.class.singular_resource_name}: #{attributes.inspect}"
     end
-    alias :inspect :to_s
 
     # @private
     def inspect
@@ -54,10 +54,10 @@ module FreshdeskAPI
 
     # Compares resources by class and id. If id is nil, then by object_id
     def ==(other)
-      return true if other.object_id == self.object_id
+      return true if other.object_id == object_id
 
       if other && !other.is_a?(Data)
-        warn "Trying to compare #{other.class} to a Resource from #{caller.first}"
+        warn "Trying to compare #{other.class} to a Resource from #{caller(1..1).first}"
       end
 
       if other.is_a?(Data)
@@ -66,7 +66,6 @@ module FreshdeskAPI
         false
       end
     end
-
   end
 
   # Represents a resource that can CRUD (create, read, update, destroy)
@@ -76,5 +75,4 @@ module FreshdeskAPI
     include Update
     include Destroy
   end
-
 end

data/lib/freshdesk_api/resources/solution_article.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'freshdesk_api/resource'
 
 module FreshdeskAPI
   class SolutionArticle < Resource
     # Need to specify the category_id and folder_id in url
 
-    def api_url(options = {})
-      "/solution/categories/%{category_id}/folders/%{folder_id}/articles" % attributes
+    def api_url(_options = {})
+      format('/solution/categories/%<category_id>/folders/%<folder_id>/articles', attributes)
     end
 
     def request_namespace
@@ -18,14 +20,12 @@ module FreshdeskAPI
 
     class << self
       def api_url(options = {})
-        "/solution/categories/%{category_id}/folders/%{folder_id}/articles" % options
+        format('/solution/categories/%<category_id>/folders/%<folder_id>/articles', options)
       end
 
       def collection_namespace
         'folder/articles'
       end
-
     end
-
   end
 end

data/lib/freshdesk_api/resources/solution_category.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'freshdesk_api/resource'
 
 module FreshdeskAPI
   class SolutionCategory < Resource
-    def api_url(options = {})
-      "/solution/categories"
+    def api_url(_options = {})
+      '/solution/categories'
     end
 
     def request_namespace
@@ -14,16 +16,14 @@ module FreshdeskAPI
       :category
     end
 
-
     class << self
-      def api_url(options = {})
-        "/solution/categories"
+      def api_url(_options = {})
+        '/solution/categories'
       end
 
       def collection_namespace
         'category'
       end
     end
-
   end
 end

data/lib/freshdesk_api/resources/solution_folder.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'freshdesk_api/resource'
 
 module FreshdeskAPI
   class SolutionFolder < Resource
     # Need to specify category_id in url
 
-    def api_url(options = {})
-      "/solution/categories/%{category_id}/folders" % attributes
+    def api_url(_options = {})
+      format('/solution/categories/%<category_id>/folders', attributes)
     end
 
     def request_namespace
@@ -18,14 +20,12 @@ module FreshdeskAPI
 
     class << self
       def api_url(options = {})
-        "/solution/categories/%{category_id}/folders" % options
+        format('/solution/categories/%<category_id>/folders', options)
       end
 
       def collection_namespace
         'category/folders'
       end
-
     end
-
   end
 end

data/lib/freshdesk_api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FreshdeskAPI
-  VERSION = "0.1.3"
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freshdesk_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Anton Maminov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-15 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: deep_merge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: deep_merge
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,30 +70,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 description: Ruby wrapper for the REST API at http://freshdesk.com. Documentation
   at http://freshdesk.com/api.
 email:
@@ -132,6 +146,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -163,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -171,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Freshdesk REST API Client