zendesk2 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57938a7a4d8d6885607eb9ce942295373b41559b
-  data.tar.gz: b56d6e5fc5b3505f8ebe107bca1198cdfa568dc8
+  metadata.gz: a4b6c9e3a2263e5d8e84d8c0d408c2a40d898106
+  data.tar.gz: db66a761d97b525ef31cb6d63ae5b6d28b5751fe
 SHA512:
-  metadata.gz: 9147be1837cf536af9c09ffd595dbf2542cfc759d160162d70f7e141d680502dfcc057f67a13997b18d501aae4f73d5dc867b17265bcb566e39ea7e08b8759e7
-  data.tar.gz: 345b472a1182294e3a5a23a1bfac5b775bcb024f020d3117bc78737d781b5797c206df09273eab2084493aa127d6415aa748a9d2855399238ddf4b1042893bd4
+  metadata.gz: f14e79bbd8b508ce7f9d22e31e4249f85ffeb4fd153b4ae244ac79293425b76ab63253c7ea8723cb1b57be64376f9dd8637ee034a25a24917d61b99e2deeb704
+  data.tar.gz: a8b6cc3a9da6ecd75fe1174a59b790076b9f2c51004318199e9b759c634008aa6bac5a57b276125315c53c610380b5290aaf8f4e012061c9ae3543e51262c9b0

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+Metrics/LineLength:
+  Max: 120
+Style/BlockDelimiters:
+  EnforcedStyle: line_count_based
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+Metrics/AbcSize:
+  Max: 75
+Metrics/MethodLength:
+  Max: 50
+Metrics/ClassLength:
+  Max: 300
+Metrics/ModuleLength:
+  Max: 300
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/PerceivedComplexity:
+  Max: 10
+Style/TrailingCommaInArguments:
+  Enabled: false
+  #EnforcedStyleForMultiline: consistent_comma # this is very broke
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -6,6 +6,8 @@ rvm:
   - 2.3.0
   - 2.2.4
   - 2.1.8
-script: "bundle exec rake --trace"
+script: 
+  - bundle exec rubocop -Da
+  - bundle exec rake spec
 notifications:
   email: false

data/Gemfile

@@ -1,15 +1,14 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in zendesk2.gemspec
 gemspec
 
 gem 'rake'
- # To avoid warnings from JWT
+# To avoid warnings from JWT
 gem 'json', '~> 1.8'
-
-group :development, :test do
-  gem 'pry-nav'
-end
+gem 'rubocop', '~> 0.41', require: false
+gem 'pry-nav'
 
 group :test do
   gem 'awesome_print'

data/Guardfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 guard 'bundler' do
   watch('Gemfile')
   watch(/^.+\.gemspec/)
@@ -5,7 +6,7 @@ end
 
 guard 'rspec', cmd: 'bundle exec rspec', all_on_start: true, all_after_pass: true, failed_mode: :focus do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { "spec" }
-  watch('spec/spec_helper.rb')  { "spec" }
-  watch(%r{^spec/(support|matchers|shared)/(.+)\.rb$}) { "spec" }
+  watch(%r{^lib/(.+)\.rb$})     { 'spec' }
+  watch('spec/spec_helper.rb')  { 'spec' }
+  watch(%r{^spec/(support|matchers|shared)/(.+)\.rb$}) { 'spec' }
 end

data/Rakefile

@@ -1,9 +1,10 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.rspec_opts = "-cfp"
+  spec.rspec_opts = '-cfp'
 end
 
-task :default => :spec
+task default: :spec

data/lib/zendesk2.rb

@@ -1,4 +1,5 @@
-require "zendesk2/version"
+# frozen_string_literal: true
+require 'zendesk2/version'
 
 # dependencies
 require 'cistern'
@@ -14,14 +15,17 @@ require 'time'
 require 'yaml'
 require 'securerandom'
 
+# welcome
 module Zendesk2
   include Cistern::Client.with(interface: :module)
 
-  USER_AGENT = "Ruby/#{RUBY_VERSION} (#{RUBY_PLATFORM}; #{RUBY_ENGINE}) Zendesk2/#{Zendesk2::VERSION} Faraday/#{Faraday::VERSION}".freeze
+  USER_AGENT = <<-UA
+  Ruby/#{RUBY_VERSION} (#{RUBY_PLATFORM}; #{RUBY_ENGINE}) Zendesk2/#{Zendesk2::VERSION} Faraday/#{Faraday::VERSION}
+  UA
 
   def self.defaults
     @defaults ||= begin
-                    YAML.load_file(File.expand_path("~/.zendesk2"))
+                    YAML.load_file(File.expand_path('~/.zendesk2'))
                   rescue ArgumentError, Errno::ENOENT
                     # handle missing home directories or missing file
                     {}
@@ -29,14 +33,13 @@ module Zendesk2
   end
 
   def self.stringify_keys(hash)
-    hash.inject({}) { |r,(k,v)| r.merge(k.to_s => v) }
+    hash.inject({}) { |r, (k, v)| r.merge(k.to_s => v) }
   end
 
   def self.blank?(string)
-    string.nil? || string == ""
+    string.nil? || string == ''
   end
 
-
   recognizes :url, :logger, :adapter, :username, :password, :token, :jwt_token
 end
 

data/lib/zendesk2/attributes.rb

@@ -1,27 +1,30 @@
+# frozen_string_literal: true
 module Zendesk2::Attributes
-  def assoc_reader(name, options={})
+  def assoc_reader(name, options = {})
     assoc_key  = options[:key] || "#{name}_id"
     collection = options[:collection] || "#{name}s"
     define_method(name) do
-      if assoc_id = self.send(assoc_key)
-        self.cistern.send(collection).get(assoc_id)
-      else self.instance_variable_get("@#{name}")
+      assoc_id = send(assoc_key)
+      if assoc_id
+        cistern.send(collection).get(assoc_id)
+      else
+        instance_variable_get("@#{name}")
       end
     end
   end
 
-  def assoc_writer(name, options={})
+  def assoc_writer(name, options = {})
     assoc_key = options[:key] || "#{name}_id"
     define_method("#{name}=") do |assoc|
       if assoc.is_a?(Cistern::Model)
-        self.send("#{assoc_key}=", assoc.identity)
+        send("#{assoc_key}=", assoc.identity)
       else
-        self.instance_variable_set("@#{name}", assoc)
+        instance_variable_set("@#{name}", assoc)
       end
     end
   end
 
-  def assoc_accessor(name, options={})
+  def assoc_accessor(name, options = {})
     assoc_reader(name, options)
     assoc_writer(name, options)
   end

data/lib/zendesk2/audit_event.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # @abstract subclass and implement audit event specific attributes
 class Zendesk2::AuditEvent
   include Zendesk2::Model
@@ -14,11 +15,12 @@ class Zendesk2::AuditEvent
   end
 
   def self.for(attributes)
-    event_class = "Zendesk2::Ticket#{attributes["type"]}"
-    if klass = all.find{|k| k.name == event_class}
+    event_class = "Zendesk2::Ticket#{attributes['type']}"
+    klass = all.find { |k| k.name == event_class }
+    if klass
       klass.new(attributes)
     else # handle unrecognized audit events
-      attributes.reject{|k,v| k == :cistern}
+      attributes.reject { |k, _v| k == :cistern }
     end
   end
 

data/lib/zendesk2/categories.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Zendesk2::Categories
   include Zendesk2::Collection
 
@@ -7,8 +8,8 @@ class Zendesk2::Categories
   model Zendesk2::Category
 
   self.collection_method = :get_categories
-  self.collection_root   = "categories"
+  self.collection_root   = 'categories'
   self.model_method      = :get_category
-  self.model_root        = "category"
-  self.search_type       = "category"
+  self.model_root        = 'category'
+  self.search_type       = 'category'
 end

data/lib/zendesk2/category.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 class Zendesk2::Category
   include Zendesk2::Model
 
-
   # @return [Integer] Automatically assigned during creation
   identity :id, type: :integer
 
@@ -21,18 +21,18 @@ class Zendesk2::Category
   def destroy!
     requires :identity
 
-    cistern.destroy_category("category" => {"id" => self.identity})
+    cistern.destroy_category('category' => { 'id' => identity })
   end
 
   def save!
     data = if new_record?
              requires :name
 
-             cistern.create_category(params).body["category"]
+             cistern.create_category(params).body['category']
            else
              requires :identity
 
-             cistern.update_category(params).body["category"]
+             cistern.update_category(params).body['category']
            end
 
     merge_attributes(data)
@@ -41,6 +41,11 @@ class Zendesk2::Category
   protected
 
   def params
-    {"category" => Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *Zendesk2::CreateCategory.accepted_attributes)}
+    {
+      'category' => Cistern::Hash.slice(
+        Zendesk2.stringify_keys(attributes),
+        *Zendesk2::CreateCategory.accepted_attributes
+      ),
+    }
   end
 end

data/lib/zendesk2/client.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 # @deprecated use {#Zendesk2}
 module Zendesk2::Client
   def self.method_missing(message, *args, &block)
-    Cistern.deprecation("Zendesk2::Client is deprecated, use Zendesk2", caller[1])
+    Cistern.deprecation('Zendesk2::Client is deprecated, use Zendesk2', caller[1])
 
     if Zendesk2.respond_to?(message)
       Zendesk2.public_send(message, *args, &block)
@@ -11,9 +12,8 @@ module Zendesk2::Client
   end
 
   def self.respond_to?(message)
-    Cistern.deprecation("Zendesk2::Client is deprecated, use Zendesk2", caller[1])
+    Cistern.deprecation('Zendesk2::Client is deprecated, use Zendesk2', caller[1])
 
     Zendesk2.respond_to?(message) || super
   end
 end
-

data/lib/zendesk2/collection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Zendesk2::Collection
   class << self
     alias cistern_included included
@@ -9,13 +10,14 @@ module Zendesk2::Collection
     end
   end
 
+  # Add interface methods for response constants
   module ClassMethods
     attr_accessor :collection_method, :collection_root, :model_method, :model_root
 
     attr_writer :namespace
 
     def namespace
-      @namespace || self.model_root
+      @namespace || model_root
     end
 
     def scopes
@@ -23,35 +25,49 @@ module Zendesk2::Collection
     end
   end
 
-  def collection_method; self.class.collection_method; end
-  def collection_root; self.class.collection_root; end
-  def model_method; self.class.model_method; end
-  def model_root; self.class.model_root; end
-  def namespace; self.class.namespace; end
+  def collection_method
+    self.class.collection_method
+  end
+
+  def collection_root
+    self.class.collection_root
+  end
+
+  def model_method
+    self.class.model_method
+  end
+
+  def model_root
+    self.class.model_root
+  end
+
+  def namespace
+    self.class.namespace
+  end
 
   # Attempt creation of resource and explode if unsuccessful
   # @raise [Zendesk2::Error] if creation was unsuccessful
   # @return [Cistern::Model]
-  def create!(attributes={})
-    model = self.new(attributes.merge(Zendesk2.stringify_keys(self.attributes)))
+  def create!(attributes = {})
+    model = new(attributes.merge(Zendesk2.stringify_keys(self.attributes)))
     model.save!
   end
 
   # Quietly attempt creation of resource. Check {#new_record?} and {#errors} for success
   # @see {#create!} to raise an exception on failure
   # @return [Cistern::Model, FalseClass]
-  def create(attributes={})
-    model = self.new(attributes.merge(Zendesk2.stringify_keys(self.attributes)))
+  def create(attributes = {})
+    model = new(attributes.merge(Zendesk2.stringify_keys(self.attributes)))
     model.save
   end
 
   # Fetch a collection of resources
-  def all(params={})
-    scoped_attributes = self.class.scopes.inject({}){|r,k| r.merge(k.to_s => send(k))}.merge(params)
+  def all(params = {})
+    scoped_attributes = self.class.scopes.inject({}) { |a, e| a.merge(e.to_s => public_send(e)) }.merge(params)
     body = cistern.send(collection_method, scoped_attributes).body
 
-    self.load(body[collection_root])
-    self.merge_attributes(Cistern::Hash.slice(body, "count"))
+    load(body[collection_root])
+    merge_attributes(Cistern::Hash.slice(body, 'count'))
     self
   end
 
@@ -70,19 +86,17 @@ module Zendesk2::Collection
   # @raise [Zendesk2::Error] if the record cannot be found or other request error
   # @return [Zendesk2::Model] fetched resource corresponding to value of {Zendesk2::Collection#model}
   def get!(identity_or_hash)
-    scoped_attributes = self.class.scopes.inject({}) { |r,k| r.merge(k.to_s => send(k)) }
+    scoped_attributes = self.class.scopes.inject({}) { |a, e| a.merge(e.to_s => public_send(e)) }
 
     if identity_or_hash.is_a?(Hash)
       scoped_attributes.merge!(identity_or_hash)
     else
-      scoped_attributes.merge!("id" => identity_or_hash)
+      scoped_attributes['id'] = identity_or_hash
     end
 
     scoped_attributes = { namespace => scoped_attributes }
-
-    if data = self.cistern.send(model_method, scoped_attributes).body[self.model_root]
-      new(data)
-    end
+    data = cistern.send(model_method, scoped_attributes).body[model_root]
+    new(data) if data
   end
 
   # Quiet version of {#get!}
@@ -95,7 +109,7 @@ module Zendesk2::Collection
     nil
   end
 
-  def new(attributes={})
+  def new(attributes = {})
     super(self.attributes.merge(attributes))
   end
 end

data/lib/zendesk2/create_category.rb

@@ -1,26 +1,27 @@
+# frozen_string_literal: true
 class Zendesk2::CreateCategory
   include Zendesk2::Request
 
   request_method :post
-  request_path { |_| "/categories.json" }
-  request_body { |r| {"category" => r.params["category"]} }
+  request_path { |_| '/categories.json' }
+  request_body { |r| { 'category' => r.params['category'] } }
 
   def self.accepted_attributes
-    %w[id name description position]
+    %w(id name description position)
   end
 
   def mock
     identity = cistern.serial_id
 
     record = {
-      "id"         => identity,
-      "url"        => url_for("/categories/#{identity}.json"),
-      "created_at" => Time.now.iso8601,
-      "updated_at" => Time.now.iso8601,
-    }.merge(Cistern::Hash.slice(params.fetch("category"), *self.class.accepted_attributes))
+      'id'         => identity,
+      'url'        => url_for("/categories/#{identity}.json"),
+      'created_at' => Time.now.iso8601,
+      'updated_at' => Time.now.iso8601,
+    }.merge(Cistern::Hash.slice(params.fetch('category'), *self.class.accepted_attributes))
 
     cistern.data[:categories][identity] = record
 
-    mock_response({"category" => record}, {status: 201})
+    mock_response({ 'category' => record }, { status: 201 })
   end
 end