zendesk2 1.7.5 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba9aaddee3b5e8d5e7d1d01ce72e055049d5849f
-  data.tar.gz: 9ef2c02dee825ed9349e7491f0f5e28eeae05b11
+  metadata.gz: 47765b2ecc5d355c801ffb42c539133e3e52c5f0
+  data.tar.gz: 8539465b4426c2ac045fb947564465b2932c9011
 SHA512:
-  metadata.gz: 4dbfefa96c6b4bb94e492e77d0a2a322caed057f0f811490441d3514b05b7a2363041c1d133bb33defde20765e1924902baee70b1366a55b7036fd435f0d2ee5
-  data.tar.gz: 6a05b57f7b0e4ed190e9eba37ac089ad76796021997ba53ae6016b334fb8df88fd9ea20fad8a21d99fbbfcbd08f9af81e37e67d566d9c923dfee661dca326005
+  metadata.gz: cdea7b59ded18ae6a9f01a7b7bf88a23db8674d8f878bf1eb2832476305c1b590bbe2586a53e75eaa7f1c0eedbca32547985394ede25f3050c73d9a27c5f7317
+  data.tar.gz: e114b86cac3a84db21f6d190a13f79ef09bb435c105105d107c2f483bc11d3824daccc296bfa2cabb73e88deb03b33f8453feb8734a236cf478598f516575d1d

data/.travis.yml

@@ -3,10 +3,9 @@ sudo: false
 cache:
   - bundler
 rvm:
-  - "2.2"
-  - "1.9"
+  - 2.3.0
+  - 2.2.4
+  - 2.1.8
 script: "bundle exec rake --trace"
 notifications:
-  email:
-    on_success: never
-    on_failure: change
+  email: false

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Change Log
 
+## [Unreleased](https://github.com/lanej/zendesk2/tree/HEAD)
+
+[Full Changelog](https://github.com/lanej/zendesk2/compare/v1.8.0...HEAD)
+
+**Merged pull requests:**
+
+- use Cistern module interface [\#47](https://github.com/lanej/zendesk2/pull/47) ([lanej](https://github.com/lanej))
+
+## [v1.8.0](https://github.com/lanej/zendesk2/tree/v1.8.0) (2016-05-19)
+[Full Changelog](https://github.com/lanej/zendesk2/compare/v1.7.5...v1.8.0)
+
+**Merged pull requests:**
+
+- Add Access Policies for Help Center Sections [\#45](https://github.com/lanej/zendesk2/pull/45) ([omgitsads](https://github.com/omgitsads))
+- remove 1.9 support [\#44](https://github.com/lanej/zendesk2/pull/44) ([lanej](https://github.com/lanej))
+- peel back unnecessary Client namespace [\#41](https://github.com/lanej/zendesk2/pull/41) ([lanej](https://github.com/lanej))
+
+## [v1.7.5](https://github.com/lanej/zendesk2/tree/v1.7.5) (2016-04-02)
+[Full Changelog](https://github.com/lanej/zendesk2/compare/v1.7.4...v1.7.5)
+
+**Merged pull requests:**
+
+- Add optional locale parameter to get\_help\_center\_sections\_articles [\#42](https://github.com/lanej/zendesk2/pull/42) ([TranquilMarmot](https://github.com/TranquilMarmot))
+
 ## [v1.7.4](https://github.com/lanej/zendesk2/tree/v1.7.4) (2015-11-10)
 [Full Changelog](https://github.com/lanej/zendesk2/compare/v1.7.3...v1.7.4)
 

data/Gemfile

@@ -13,8 +13,6 @@ end
 
 group :test do
   gem 'awesome_print'
-  gem 'guard-bundler', require: false
-  gem 'guard-rspec', '~> 4.3', require: false
   gem 'rspec', '~> 3.2'
   gem 'rack-test'
 end

data/README.md

@@ -5,7 +5,7 @@
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/lanej/zendesk2)
 [![Dependency Status](https://gemnasium.com/lanej/zendesk2.png)](https://gemnasium.com/lanej/zendesk2)
 
-Ruby client for the [Zendesk V2 API](http://developer.zendesk.com/documentation/rest_api/introduction.html) using [cistern](https://github.com/lanej/cistern) and [faraday](https://github.com/technoweenie/faraday)
+Ruby client for the [Zendesk V2 API](http://developer.zendesk.com/documentation/rest_api/introduction.html) using [cistern](https://github.com/lanej/cistern) and [faraday](https://github.com/technoweenie/faraday).  Ruby > 2.0 is required
 
 ## Installation
 
@@ -24,10 +24,10 @@ Or install it yourself as:
 All support resources have basic mocks.  Error conditions and messaging are constantly changing. Please contribute updates or fixes to the mock if you encounter inconsistencies.
 
 ```ruby
-Zendesk2::Client.mock!
+Zendesk2.mock!
 
-client = Zendesk2::Client.new(...) # Zendesk2::Client::Mock
-client.organizations.create!(name: "foo") # Zendesk2::Client::Organization
+client = Zendesk2.new(...) # Zendesk2::Mock
+client.organizations.create!(name: "foo") # Zendesk2::Organization
 client.organizations.create!(name: "foo") # Zendesk2::Error => Name has already been taken
 ```
 
@@ -48,8 +48,8 @@ Default credentials will be read in from `~/.zendesk2` file in YAML format.
 Url is always required. Username and either password or token are always required.
 
 ```ruby
-Zendesk2::Client.new(url: "http://support.cloud.engineyard.com", username: "mate", token: "asdfghjkl1qwertyuiop5zxcvbnm3")
-=> #<Zendesk2::Client::Real:0x007fd1bae486b0 @url="http://support.cloud.engineyard.com", @username="mate", @token="asdfghjkl1qwertyuiop5zxcvbnm3", …>
+Zendesk2.new(url: "http://support.cloud.engineyard.com", username: "mate", token: "asdfghjkl1qwertyuiop5zxcvbnm3")
+=> #<Zendesk2::Real:0x007fd1bae486b0 @url="http://support.cloud.engineyard.com", @username="mate", @token="asdfghjkl1qwertyuiop5zxcvbnm3", …>
 ```
 
 ### Resources
@@ -84,12 +84,12 @@ All collection are accessed like so:
 
 ```ruby
 client.users.all
-=> <Zendesk2::Client::Users
+=> <Zendesk2::Users
   count=1779,
   next_page_link="https://dev.zendesk.com/api/v2/users.json?page=2",
   previous_page_link=nil
   [
-    <Zendesk2::Client::User
+    <Zendesk2::User
       id=125394183,
       url="https://dev.zendesk.com/api/v2/users/125394183.json",
       ...
@@ -101,7 +101,7 @@ Collections also respond to `create` and `new`
 
 ```ruby
 client.users.create(email: "ohhai@example.org", name: "lulz")
-=> <Zendesk2::Client::User
+=> <Zendesk2::User
   id=234020811,
   ...
   url="https://engineyarddev.zendesk.com/api/v2/users/234020811.json",
@@ -112,7 +112,7 @@ client.users.create(email: "ohhai@example.org", name: "lulz")
 
 ```ruby
 client.users.new(email: "ohhai@example.org")
-=> <Zendesk2::Client::User
+=> <Zendesk2::User
   id=nil,
   ...
   url=nil,
@@ -128,12 +128,12 @@ Paged collections respond to `next_page` and `previous_page` when appropriate.
 
 ```ruby
 page = client.users.all("per_page" => 1, "page" => 4)
-=> <Zendesk2::Client::Users
+=> <Zendesk2::Users
   count=1780,
   next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1",
   previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1"
   [
-    <Zendesk2::Client::User
+    <Zendesk2::User
       id=217761652,
       url="https://dev.zendesk.com/api/v2/users/217761652.json",
       external_id=nil,
@@ -145,12 +145,12 @@ page = client.users.all("per_page" => 1, "page" => 4)
 
 ```ruby
 page.next_page
-=> <Zendesk2::Client::Users
+=> <Zendesk2::Users
   count=1780,
   next_page_link="https://dev.zendesk.com/api/v2/users.json?page=6&per_page=1",
   previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=4&per_page=1"
   [
-    <Zendesk2::Client::User
+    <Zendesk2::User
       id=217761742,
       url="https://dev.zendesk.com/api/v2/users/217761742.json",
       ...
@@ -162,12 +162,12 @@ page.next_page
 
 ```ruby
 page.previous_page
-=> <Zendesk2::Client::Users
+=> <Zendesk2::Users
   count=1780,
   next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1",
   previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1"
   [
-    <Zendesk2::Client::User
+    <Zendesk2::User
       id=217761652,
       url="https://dev.zendesk.com/api/v2/users/217761652.json",
       ...
@@ -182,8 +182,8 @@ page.previous_page
 All models respond to `destroy` and `save` if applicable.  `save` performs a 'create' operation if there is no identity provided or an 'update' if there is an identity.
 
 ```ruby
-Zendesk2::Client::Ticket.new.save        # performs a create
-Zendesk2::Client::Ticket.new(id: 1).save # performs an update
+Zendesk2::Ticket.new.save        # performs a create
+Zendesk2::Ticket.new(id: 1).save # performs an update
 ```
 
 Attributes can be enumerated by the `attributes` method.

data/lib/zendesk2/{client/models/audit_event.rb → audit_event.rb}

@@ -1,5 +1,7 @@
 # @abstract subclass and implement audit event specific attributes
-class Zendesk2::Client::AuditEvent < Zendesk2::Client::Model
+class Zendesk2::AuditEvent
+  include Zendesk2::Model
+
   extend Zendesk2::Attributes
   extend Forwardable
 
@@ -12,7 +14,7 @@ class Zendesk2::Client::AuditEvent < Zendesk2::Client::Model
   end
 
   def self.for(attributes)
-    event_class = "Zendesk2::Client::Ticket#{attributes["type"]}"
+    event_class = "Zendesk2::Ticket#{attributes["type"]}"
     if klass = all.find{|k| k.name == event_class}
       klass.new(attributes)
     else # handle unrecognized audit events
@@ -23,7 +25,7 @@ class Zendesk2::Client::AuditEvent < Zendesk2::Client::Model
   # @return [String] has the event value
   attribute :type, type: :string
 
-  # @return [Zendesk2::Client::TicketAudit] audit that includes this event
+  # @return [Zendesk2::TicketAudit] audit that includes this event
   attr_accessor :ticket_audit
 
   def_delegators :ticket_audit, :created_at

data/lib/zendesk2/{client/collections/categories.rb → categories.rb}

@@ -1,8 +1,10 @@
-class Zendesk2::Client::Categories < Zendesk2::Client::Collection
+class Zendesk2::Categories
+  include Zendesk2::Collection
+
   include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
-  model Zendesk2::Client::Category
+  model Zendesk2::Category
 
   self.collection_method = :get_categories
   self.collection_root   = "categories"

data/lib/zendesk2/{client/models/category.rb → category.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::Category < Zendesk2::Client::Model
+class Zendesk2::Category
+  include Zendesk2::Model
+
 
   # @return [Integer] Automatically assigned during creation
   identity :id, type: :integer
@@ -39,6 +41,6 @@ class Zendesk2::Client::Category < Zendesk2::Client::Model
   protected
 
   def params
-    {"category" => Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *Zendesk2::Client::CreateCategory.accepted_attributes)}
+    {"category" => Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *Zendesk2::CreateCategory.accepted_attributes)}
   end
 end

data/lib/zendesk2/client.rb

@@ -1,63 +1,19 @@
-class Zendesk2::Client
-  include Cistern::Client
-
-  USER_AGENT = "Ruby/#{RUBY_VERSION} (#{RUBY_PLATFORM}; #{RUBY_ENGINE}) Zendesk2/#{Zendesk2::VERSION} Faraday/#{Faraday::VERSION}".freeze
-
-  recognizes :url, :logger, :adapter, :username, :password, :token, :jwt_token
-end
-
-def require_resource(resource, options={})
-  plural = options[:plural] || "#{resource}s"
-  except = Array(options[:except])
-  other  = Array(options[:and])
-
-  require "zendesk2/client/models/#{resource}"
-  require "zendesk2/client/collections/#{plural}"
-
-  require "zendesk2/client/requests/create_#{resource}"  unless except.include?(:create)
-  require "zendesk2/client/requests/destroy_#{resource}" unless except.include?(:destroy)
-  require "zendesk2/client/requests/get_#{plural}"       unless except.include?(:index)
-  require "zendesk2/client/requests/get_#{resource}"     unless except.include?(:show)
-  require "zendesk2/client/requests/update_#{resource}"  unless except.include?(:update)
-
-  other.each { |file| require "zendesk2/client/requests/#{file}" }
+# @deprecated use {#Zendesk2}
+module Zendesk2::Client
+  def self.method_missing(message, *args, &block)
+    Cistern.deprecation("Zendesk2::Client is deprecated, use Zendesk2", caller[1])
+
+    if Zendesk2.respond_to?(message)
+      Zendesk2.public_send(message, *args, &block)
+    else
+      super
+    end
+  end
+
+  def self.respond_to?(message)
+    Cistern.deprecation("Zendesk2::Client is deprecated, use Zendesk2", caller[1])
+
+    Zendesk2.respond_to?(message) || super
+  end
 end
 
-require 'zendesk2/client/real'
-require 'zendesk2/client/mock'
-require 'zendesk2/client/request'
-require 'zendesk2/client/model'
-require 'zendesk2/client/collection'
-require 'zendesk2/client/help_center'
-
-require 'zendesk2/client/requests/search'
-require 'zendesk2/client/models/audit_event'
-
-require_resource("category", plural: "categories")
-require_resource("forum")
-require_resource("group", and: ["get_assignable_groups"])
-require_resource("user", and: [
-  "search_user",
-  "get_current_user",
-  "mark_user_identity_primary",
-  "get_user_memberships",
-  "get_user_organizations",
-])
-
-require_resource("ticket", and: ["get_requested_tickets", "get_ccd_tickets"])
-require_resource("ticket_audit", except: [:create, :destroy, :update])
-require_resource("ticket_field")
-require_resource("topic")
-require_resource("topic_comment", except: [:update])
-require_resource("ticket_comment", except: [:create, :destroy, :update, :show])
-require_resource("organization", and: [
-  "get_organization_users",
-  "get_organization_tickets",
-  "get_organization_by_external_id",
-  "get_organization_memberships",
-  "search_organization",
-])
-require_resource("user_field")
-require_resource("user_identity", plural: "user_identities")
-require_resource("membership", except: [:update], and: "mark_membership_default")
-require_resource("view", and: ["get_view_tickets"])

data/lib/zendesk2/{client/collection.rb → collection.rb}

@@ -1,6 +1,15 @@
-class Zendesk2::Client::Collection
-
+module Zendesk2::Collection
   class << self
+    alias cistern_included included
+
+    def included(receiver)
+      cistern_included(receiver)
+      receiver.extend(ClassMethods)
+      super
+    end
+  end
+
+  module ClassMethods
     attr_accessor :collection_method, :collection_root, :model_method, :model_root
 
     attr_writer :namespace

data/lib/zendesk2/{client/requests/create_category.rb → create_category.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::CreateCategory < Zendesk2::Client::Request
+class Zendesk2::CreateCategory
+  include Zendesk2::Request
+
   request_method :post
   request_path { |_| "/categories.json" }
   request_body { |r| {"category" => r.params["category"]} }

data/lib/zendesk2/{client/requests/create_forum.rb → create_forum.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::CreateForum < Zendesk2::Client::Request
+class Zendesk2::CreateForum
+  include Zendesk2::Request
+
   request_method :post
   request_path { |_| "/forums.json" }
   request_body { |r| {"forum" => r.forum_params } }

data/lib/zendesk2/{client/requests/create_group.rb → create_group.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::CreateGroup < Zendesk2::Client::Request
+class Zendesk2::CreateGroup
+  include Zendesk2::Request
+
   request_method :post
   request_path { |_| "/groups.json" }
   request_body { |r|  { "group" => r.group_params } }

data/lib/zendesk2/{client/requests/create_membership.rb → create_membership.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::CreateMembership < Zendesk2::Client::Request
+class Zendesk2::CreateMembership
+  include Zendesk2::Request
+
   request_method :post
   request_path { |r|  "/users/#{r.user_id}/organization_memberships.json" }
   request_body { |r| { "organization_membership" => r.membership_params } }

data/lib/zendesk2/{client/requests/create_organization.rb → create_organization.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::CreateOrganization < Zendesk2::Client::Request
+class Zendesk2::CreateOrganization
+  include Zendesk2::Request
+
   request_method :post
   request_path { |_| "/organizations.json" }
   request_body { |r|  { "organization" => r.organization_params } }

data/lib/zendesk2/{client/requests/create_ticket.rb → create_ticket.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::CreateTicket < Zendesk2::Client::Request
+class Zendesk2::CreateTicket
+  include Zendesk2::Request
+
   request_method :post
   request_path { |_| "/tickets.json" }
   request_body { |r| {"ticket" => r.ticket_params} }

data/lib/zendesk2/{client/requests/create_ticket_field.rb → create_ticket_field.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::CreateTicketField < Zendesk2::Client::Request
+class Zendesk2::CreateTicketField
+  include Zendesk2::Request
+
   request_method :post
   request_path { |_| "/ticket_fields.json" }
   request_body { |r| { "ticket_field" => r.ticket_field_params } }

data/lib/zendesk2/{client/requests/create_topic.rb → create_topic.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::CreateTopic < Zendesk2::Client::Request
+class Zendesk2::CreateTopic
+  include Zendesk2::Request
+
   request_method :post
   request_body { |r| { "topic" => r.topic_params } }
   request_path { |_| "/topics.json" }

data/lib/zendesk2/{client/requests/create_topic_comment.rb → create_topic_comment.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::CreateTopicComment < Zendesk2::Client::Request
+class Zendesk2::CreateTopicComment
+  include Zendesk2::Request
+
   request_method :post
   request_path { |r| "/topics/#{r.topic_id}/comments.json" }
   request_body { |r| { "topic_comment" => r.topic_comment_params } }

data/lib/zendesk2/{client/requests/create_user.rb → create_user.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::CreateUser < Zendesk2::Client::Request
+class Zendesk2::CreateUser
+  include Zendesk2::Request
+
   request_method :post
   request_path { |_| "/users.json" }
   request_body { |r| { "user" => r.user_params } }

data/lib/zendesk2/{client/requests/create_user_field.rb → create_user_field.rb}

@@ -1,4 +1,6 @@
-class Zendesk2::Client::CreateUserField < Zendesk2::Client::Request
+class Zendesk2::CreateUserField
+  include Zendesk2::Request
+
   request_method :post
   request_path { |_| "/user_fields.json" }
   request_body { |r| { "user_field" => r.user_field_params } }