zendesk2 0.1.2 → 0.1.3

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .rspec
+doc/

data/Guardfile

@@ -7,4 +7,5 @@ guard 'rspec' 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" }
 end

data/README.md

@@ -28,11 +28,12 @@ Default credentials will be read in from `~/.zendesk2` file in YAML format.
 :subdomain: zendeskdev
 :username: zendeskedge@example.com
 :password: wickedsecurepassword
+:token: reallylongrandomstringprovidedbyzendesk
 ```
 
 ### Creating the client
 
-Either the absolute url or the subdomain is required.  Username and password is always required.
+Either the absolute url or the subdomain is required. Username and either password or token are always required.
 
 ```ruby
 Zendesk2::Client.new(subdomain: "engineyard", username: "orchestra", password: "gwoo")
@@ -42,8 +43,8 @@ Zendesk2::Client.new(subdomain: "engineyard", username: "orchestra", password: "
 or
 
 ```ruby
-Zendesk2::Client.new(url: "http://support.cloud.engineyard.com", username: "mate", password: "bambilla")
-=> #<Zendesk2::Client::Real:0x007fd1bae486b0 @url="http://support.cloud.engineyard.com", @username="mate", @password="bambilla", …>
+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", …>
 ```
 
 ### Resources
@@ -55,6 +56,7 @@ Currently support resources
 * Audit Events
 * Categories
 * Forums
+* Groups
 * Organization
 * Ticket Audits
 * Tickets

data/TODO.md

@@ -1,2 +1,4 @@
 # yarddoc
-  * change attribute enumerations to use yarddoc format
+  * forum
+  * organization
+  * topic

data/lib/zendesk2/client/models/categories.rb

@@ -1,12 +1,11 @@
 class Zendesk2::Client::Categories < Zendesk2::Collection
-  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Category
 
-  self.collection_method= :get_categories
-  self.collection_root= "categories"
-  self.model_method= :get_category
-  self.model_root= "category"
-  self.search_type= "category"
+  self.collection_method = :get_categories
+  self.collection_root   = "categories"
+  self.model_method      = :get_category
+  self.model_root        = "category"
+  self.search_type       = "category"
 end

data/lib/zendesk2/client/models/category.rb

@@ -1,13 +1,21 @@
 class Zendesk2::Client::Category < Zendesk2::Model
   PARAMS = %w[id name description position]
 
-  identity  :id, type: :integer         # ro[yes] mandatory[no]  Automatically assigned during creation
-  attribute :url, type: :string         # ro[yes] mandatory[no]  The API url of this category
-  attribute :name, type: :string        # ro[no]  mandatory[yes] The name of the category
-  attribute :description, type: :string # ro[no]  mandatory[no]  The description of the category
-  attribute :position, type: :integer   # ro[no]  mandatory[no]  The position of this category relative to other categories
-  attribute :created_at, type: :date    # ro[yes] mandatory[no]  The time the category was created
-  attribute :updated_at, type: :date    # ro[yes] mandatory[no]  The time of the last update of the category
+  # @return [Integer] Automatically assigned during creation
+  identity :id, type: :integer
+
+  # @return [Time] The time the category was created
+  attribute :created_at, type: :time
+  # @return [String] The description of the category
+  attribute :description, type: :string
+  # @return [String] The name of the category
+  attribute :name, type: :string
+  # @return [Integer] The position of this category relative to other categories
+  attribute :position, type: :integer
+  # @return [Time] The time of the last update of the category
+  attribute :updated_at, type: :time
+  # @return [String] The API url of this category
+  attribute :url, type: :string
 
   def destroy
     requires :id
@@ -22,9 +30,11 @@ class Zendesk2::Client::Category < Zendesk2::Model
   def save!
     data = if new_record?
              requires :name
+
              connection.create_category(params).body["category"]
            else
-             requires :id
+             requires :identity
+
              connection.update_category(params).body["category"]
            end
     merge_attributes(data)

data/lib/zendesk2/client/models/forums.rb

@@ -1,12 +1,11 @@
 class Zendesk2::Client::Forums < Zendesk2::Collection
-  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Forum
 
-  self.collection_method= :get_forums
-  self.collection_root= "forums"
-  self.model_method= :get_forum
-  self.model_root= "forum"
-  self.search_type= "forum"
+  self.collection_method = :get_forums
+  self.collection_root   = "forums"
+  self.model_method      = :get_forum
+  self.model_root        = "forum"
+  self.search_type       = "forum"
 end

data/lib/zendesk2/client/models/group.rb

@@ -0,0 +1,48 @@
+class Zendesk2::Client::Group < Zendesk2::Model
+  extend Zendesk2::Attributes
+
+  PARAMS = %w[name]
+
+  # @return [Integer] Automatically assigned when creating groups
+  identity :id, type: :integer
+
+  # @return [Time] The time the group was created
+  attribute :created_at, type: :time
+  # @return [Boolean] Deleted groups get marked as such
+  attribute :deleted, type: :boolean
+  # @return [String] The name of the group
+  attribute :name, type: :string
+  # @return [Time] The time of the last update of the group
+  attribute :updated_at, type: :time
+  # @return [String] The API url of this group
+  attribute :url, type: :string
+
+  def save!
+    data = if new_record?
+             requires :name
+             connection.create_group(params).body["group"]
+           else
+             requires :identity
+             connection.update_group(params.merge("id" => self.identity)).body["group"]
+           end
+
+    merge_attributes(data)
+  end
+
+  def destroy
+    requires :identity
+
+    connection.destroy_group("id" => self.identity)
+    self.deleted = true
+  end
+
+  def destroyed?
+    self.deleted
+  end
+
+  private
+
+  def params
+    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+  end
+end

data/lib/zendesk2/client/models/groups.rb

@@ -0,0 +1,17 @@
+class Zendesk2::Client::Groups < Zendesk2::Collection
+  include Zendesk2::Searchable
+
+  model Zendesk2::Client::Group
+
+  self.collection_method = :get_groups
+  self.collection_root   = "groups"
+  self.model_method      = :get_group
+  self.model_root        = "group"
+  self.search_type       = "group"
+
+  def assignable
+    data = self.connection.get_assignable_groups.body
+    collection = self.connection.groups.load(data["groups"])
+    collection.merge_attributes(Cistern::Hash.slice(data, "next_page", "previous_page", "count"))
+  end
+end

data/lib/zendesk2/client/models/organizations.rb

@@ -1,12 +1,11 @@
 class Zendesk2::Client::Organizations < Zendesk2::Collection
-  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Organization
 
-  self.collection_method= :get_organizations
-  self.collection_root= "organizations"
-  self.model_method= :get_organization
-  self.model_root= "organization"
-  self.search_type= "organization"
+  self.collection_method = :get_organizations
+  self.collection_root   = "organizations"
+  self.model_method      = :get_organization
+  self.model_root        = "organization"
+  self.search_type       = "organization"
 end

data/lib/zendesk2/client/models/ticket_audits.rb

@@ -1,5 +1,4 @@
 class Zendesk2::Client::TicketAudits < Zendesk2::Collection
-  include Zendesk2::PagedCollection
 
   model Zendesk2::Client::TicketAudit
 

data/lib/zendesk2/client/models/tickets.rb

@@ -1,12 +1,11 @@
 class Zendesk2::Client::Tickets < Zendesk2::Collection
-  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Ticket
 
-  self.collection_method= :get_tickets
-  self.collection_root= "tickets"
-  self.model_method= :get_ticket
-  self.model_root= "ticket"
-  self.search_type= "ticket"
+  self.collection_method = :get_tickets
+  self.collection_root   = "tickets"
+  self.model_method      = :get_ticket
+  self.model_root        = "ticket"
+  self.search_type       = "ticket"
 end

data/lib/zendesk2/client/models/topic_comment.rb

@@ -46,7 +46,7 @@ class Zendesk2::Client::TopicComment < Zendesk2::Model
   def reload
     requires :identity
 
-    if data = collection.get(topic_id, identity)
+    if data = self.connection.topic_comments("topic_id" => topic_id).get(identity)
       new_attributes = data.attributes
       merge_attributes(new_attributes)
       self

data/lib/zendesk2/client/models/topic_comments.rb

@@ -1,5 +1,4 @@
 class Zendesk2::Client::TopicComments < Zendesk2::Collection
-  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::TopicComment
@@ -12,19 +11,5 @@ class Zendesk2::Client::TopicComments < Zendesk2::Collection
   self.model_root        = "topic_comment"
   self.search_type       = "topic_comment"
 
-  def all(params={})
-    body = connection.send(collection_method, params.merge("topic_id" => self.topic_id)).body
-
-    collection = self.clone.load(body[collection_root])
-    collection.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
-    collection
-  end
-
-  def get(topic_id, topic_comment_id)
-    if data = self.connection.send(model_method, {"topic_id" => topic_id, "id" => topic_comment_id}).body[self.model_root]
-      new(data)
-    end
-  rescue Zendesk2::Error
-    nil
-  end
+  scopes << :topic_id
 end

data/lib/zendesk2/client/models/topics.rb

@@ -1,12 +1,11 @@
 class Zendesk2::Client::Topics < Zendesk2::Collection
-  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Topic
 
-  self.collection_method= :get_topics
-  self.collection_root= "topics"
-  self.model_method= :get_topic
-  self.model_root= "topic"
-  self.search_type= "topic"
+  self.collection_method = :get_topics
+  self.collection_root   = "topics"
+  self.model_method      = :get_topic
+  self.model_root        = "topic"
+  self.search_type       = "topic"
 end

data/lib/zendesk2/client/models/user.rb

@@ -95,6 +95,7 @@ class Zendesk2::Client::User < Zendesk2::Model
   end
 
   # @param [Time] timestamp time sent with intial handshake
+  # @option options [String] :return_to (nil) url to return to after handshake
   # @return [String] remote authentication login url
   # @see http://www.zendesk.com/support/api/remote-authentication
   def login_url(timestamp, options={})

data/lib/zendesk2/client/models/user_identities.rb

@@ -1,5 +1,4 @@
 class Zendesk2::Client::UserIdentities < Zendesk2::Collection
-  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::UserIdentity
@@ -12,19 +11,5 @@ class Zendesk2::Client::UserIdentities < Zendesk2::Collection
   self.model_root        = "identity"
   self.search_type       = "identity"
 
-  def all(params={})
-    body = connection.send(collection_method, params.merge("user_id" => self.user_id)).body
-
-    collection = self.clone.load(body[collection_root])
-    collection.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
-    collection
-  end
-
-  def get(user_id, user_identity_id)
-    if data = self.connection.send(model_method, {"user_id" => user_id, "id" => user_identity_id}).body[self.model_root]
-      new(data)
-    end
-  rescue Zendesk2::Error
-    nil
-  end
+  scopes << :user_id
 end

data/lib/zendesk2/client/models/user_identity.rb

@@ -46,7 +46,7 @@ class Zendesk2::Client::UserIdentity < Zendesk2::Model
   def reload
     requires :identity
 
-    if data = collection.get(user_id, identity)
+    if data = self.connection.user_identities("user_id" => user_id).get(identity)
       new_attributes = data.attributes
       merge_attributes(new_attributes)
       self

data/lib/zendesk2/client/models/users.rb

@@ -1,5 +1,4 @@
 class Zendesk2::Client::Users < Zendesk2::Collection
-  include Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::User

data/lib/zendesk2/client/requests/create_group.rb

@@ -0,0 +1,33 @@
+class Zendesk2::Client
+  class Real
+    def create_group(params={})
+      request(
+        :body   => {"group" => params},
+        :method => :post,
+        :path   => "/groups.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def create_group(params={})
+      identity = self.class.new_id
+
+      record = {
+        "id"               => identity,
+        "url"              => url_for("/groups/#{identity}.json"),
+        "created_at"       => Time.now.iso8601,
+        "updated_at"       => Time.now.iso8601,
+        "deleted"          => false,
+      }.merge(params)
+
+      self.data[:groups][identity] = record
+
+      response(
+        :method => :post,
+        :body   => {"group" => record},
+        :path   => "/groups.json"
+      )
+    end
+  end # Mock
+end # Zendesk2::Client

data/lib/zendesk2/client/requests/destroy_group.rb

@@ -0,0 +1,28 @@
+class Zendesk2::Client
+  class Real
+    def destroy_group(params={})
+      id = params["id"]
+
+      request(
+        :method => :delete,
+        :path   => "/groups/#{id}.json"
+      )
+    end
+  end
+
+  class Mock
+    def destroy_group(params={})
+      id   = params["id"]
+      body = self.data[:groups][id]
+      body["deleted"] = true
+
+      response(
+        :method => :delete,
+        :path   => "/groups/#{id}.json",
+        :body   => {
+          "group" => body,
+        },
+      )
+    end
+  end
+end

data/lib/zendesk2/client/requests/get_assignable_groups.rb

@@ -0,0 +1,20 @@
+class Zendesk2::Client
+  class Real
+    def get_assignable_groups(params={})
+      page_params = Zendesk2.paging_parameters(params)
+
+      request(
+        :params  => page_params,
+        :method  => :get,
+        :path    => "/groups/assignable.json",
+      )
+    end
+  end
+  class Mock
+    def get_assignable_groups(params={})
+      filter = lambda { |group| group.select{|g| !g['deleted'] } }
+
+      page(params, :groups, "/groups/assignable.json", "groups", filter: filter)
+    end
+  end
+end

data/lib/zendesk2/client/requests/get_group.rb

@@ -0,0 +1,34 @@
+class Zendesk2::Client
+  class Real
+    def get_group(params={})
+      id = params["id"]
+
+      request(
+        :method => :get,
+        :path => "/groups/#{id}.json"
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_group(params={})
+      id   = params["id"]
+      path = "/groups/#{id}.json"
+
+      if body = self.data[:groups][id]
+        response(
+          :path => path,
+          :body => {
+            "group" => body
+          },
+        )
+      else 
+        response(
+          :path   => path,
+          :status => 404,
+          :body => {"error" => "RecordNotFound", "description" => "Not found"},
+        )
+      end
+    end
+  end # Mock
+end

data/lib/zendesk2/client/requests/get_groups.rb

@@ -0,0 +1,18 @@
+class Zendesk2::Client
+  class Real
+    def get_groups(params={})
+      page_params = Zendesk2.paging_parameters(params)
+
+      request(
+        :params  => page_params,
+        :method  => :get,
+        :path    => "/groups.json",
+      )
+    end
+  end
+  class Mock
+    def get_groups(params={})
+      page(params, :groups, "/groups.json", "groups")
+    end
+  end
+end

data/lib/zendesk2/client/requests/update_group.rb

@@ -0,0 +1,35 @@
+class Zendesk2::Client
+  class Real
+    def update_group(params={})
+      id   = params.delete("id")
+      path = "/groups/#{id}.json"
+
+      request(
+        :method => :put,
+        :path   => path,
+        :body   => {
+          "group" => params
+        },
+      )
+    end
+  end
+  class Mock
+    def update_group(params={})
+      id   = params.delete("id")
+      path = "/groups/#{id}.json"
+
+      if group = self.data[:groups][id]
+        group.merge!(params)
+        response(
+          :method => :put,
+          :path   => "/groups/#{id}.json",
+          :body   => {
+            "group" => group
+          },
+        )
+      else response(status: 404)
+      end
+
+    end
+  end
+end

data/lib/zendesk2/client.rb

@@ -6,6 +6,7 @@ class Zendesk2::Client < Cistern::Service
 
   collection :categories
   collection :forums
+  collection :groups
   collection :organizations
   collection :ticket_audits
   collection :tickets
@@ -16,6 +17,7 @@ class Zendesk2::Client < Cistern::Service
   model :audit_event
   model :category
   model :forum
+  model :group
   model :organization
   model :ticket
   model :ticket_audit
@@ -24,8 +26,10 @@ class Zendesk2::Client < Cistern::Service
   model :user
   model :user_identity
 
+  request :get_assignable_groups
   request :create_category
   request :create_forum
+  request :create_group
   request :create_organization
   request :create_ticket
   request :create_topic
@@ -34,6 +38,7 @@ class Zendesk2::Client < Cistern::Service
   request :create_user_identity
   request :destroy_category
   request :destroy_forum
+  request :destroy_group
   request :destroy_organization
   request :destroy_ticket
   request :destroy_topic
@@ -47,6 +52,8 @@ class Zendesk2::Client < Cistern::Service
   request :get_current_user
   request :get_forum
   request :get_forums
+  request :get_group
+  request :get_groups
   request :get_organization
   request :get_organization_tickets
   request :get_organization_users
@@ -69,6 +76,7 @@ class Zendesk2::Client < Cistern::Service
   request :mark_user_identity_primary
   request :update_category
   request :update_forum
+  request :update_group
   request :update_organization
   request :update_ticket
   request :update_topic
@@ -100,14 +108,17 @@ class Zendesk2::Client < Cistern::Service
       adapter            = options[:adapter] || :net_http
       connection_options = options[:connection_options] || {ssl: {verify: false}}
       @username          = options[:username] || Zendesk2.defaults[:username]
+      token              = options[:token] || Zendesk2.defaults[:token]
       password           = options[:password] || Zendesk2.defaults[:password]
-      @token             = options[:token]
+      @username         += "/token" if token
+      @auth_token        = token || password
 
-      raise "Missing required options: [:username, :password]" unless @username && password
+      raise "Missing required options: :username" unless @username 
+      raise "Missing required options: :password or :token" unless password || token
 
       @connection = Faraday.new({url: @url}.merge(connection_options)) do |builder|
         # response
-        builder.use Faraday::Request::BasicAuthentication, @username, password
+        builder.use Faraday::Request::BasicAuthentication, @username, @auth_token
         builder.use Faraday::Response::RaiseError
         builder.response :json
 
@@ -146,6 +157,7 @@ class Zendesk2::Client < Cistern::Service
       @data ||= {
         :categories     => {},
         :forums         => {},
+        :groups         => {},
         :identities     => {},
         :organizations  => {},
         :ticket_audits  => {},

data/lib/zendesk2/collection.rb

@@ -1,5 +1,25 @@
-# @abstract adds {#create!} method
+# @abstract Subclass and set #{collection_method}, #{collection_root}, #{model_method}, #{model_root} and #{model}
+# adds {#create!} method to {Cistern::Collection}.
 class Zendesk2::Collection < Cistern::Collection
+  def self.inherited(klass)
+    klass.send(:attribute, :count)
+    klass.send(:attribute, :next_page_link, {:aliases => "next_page"})
+    klass.send(:attribute, :previous_page_link, {:aliases => "previous_page"})
+    klass.send(:extend, ClassMethods)
+  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 next_page
+    all("url" => next_page_link) if next_page_link
+  end
+
+  def previous_page
+    all("url" => previous_page_link) if previous_page_link
+  end
 
   # Attempt creation of resource and explode if unsuccessful
   # @raise [Zendesk2::Error] if creation was unsuccessful
@@ -16,4 +36,59 @@ class Zendesk2::Collection < Cistern::Collection
     model = self.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))}
+    scoped_attributes.merge!(params)
+    body = connection.send(collection_method, scoped_attributes).body
+
+    collection = self.clone.load(body[collection_root])
+    collection.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+    collection
+  end
+
+  # Fetch a single of resource
+  # @overload get!(identity)
+  #   fetch a un-namespaced specific record or a namespaced record under the current {#scopes}
+  #   @param [Integer] identity identity of the record
+  # @overload get!(scope)
+  #   directly fetch a namespaced record
+  #   @param [Hash] scope parameters to fetch record
+  # @example Fetch a record without contextual scoping
+  #   self.identities.all("user_id" => 2, "id" => 4) # context defined directly
+  # @example Fetch a record with contextual scoping
+  #   self.identities("user_id" => 2).get(4) # context defined in collection
+  #   user.identities.get(4)                 # context defined by encapsulating model
+  # @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))}
+    if identity_or_hash.is_a?(Hash)
+      scoped_attributes.merge!(identity_or_hash)
+    else scoped_attributes.merge!("id" => identity_or_hash)
+    end
+
+    if data = self.connection.send(model_method, scoped_attributes).body[self.model_root]
+      new(data)
+    end
+  end
+
+  # Quiet version of {#get!}
+  # @see #get!
+  # @return [Zendesk2::Model] Fetched model when successful
+  # @return [NilClass] return nothing if record cannot be found
+  def get(*args)
+    get!(*args)
+  rescue Zendesk2::Error
+    nil
+  end
+
+  module ClassMethods
+    attr_accessor :collection_method, :collection_root, :model_method, :model_root
+
+    def scopes
+      @scopes ||= []
+    end
+  end
 end

data/lib/zendesk2/logger.rb

@@ -1,27 +1,22 @@
-require 'forwardable'
-
 class Zendesk2::Logger < Faraday::Response::Middleware
   extend Forwardable
 
   def initialize(app, logger = nil)
     super(app)
-    @logger = logger || begin
-    require 'logger'
-    ::Logger.new(STDOUT)
-    end
+    @logger = logger || ::Logger.new(STDOUT)
   end
 
   def_delegators :@logger, :debug, :info, :warn, :error, :fatal
 
   def call(env)
-    info "#{env[:method]} #{env[:url].to_s}"
+    info("#{env[:method]} => #{env[:url].to_s}")
     debug('request') { dump_headers env[:request_headers] }
     debug('request.body') { env[:body] }
     super
   end
 
   def on_complete(env)
-    info('Status') { env[:status].to_s }
+    info("#{env[:status]} <= #{env[:url].to_s}")
     debug('response') { dump_headers env[:response_headers] }
     debug('response.body') { env[:body] }
   end

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/zendesk2.rb

@@ -9,12 +9,12 @@ require 'faraday_middleware'
 # stdlib
 require 'time'
 require 'logger'
+require 'forwardable'
 
 module Zendesk2
   autoload :Attributes, 'zendesk2/attributes'
   autoload :Error, 'zendesk2/error'
   autoload :Client, 'zendesk2/client'
-  autoload :PagedCollection, 'zendesk2/paged_collection'
   autoload :Searchable, 'zendesk2/searchable'
   autoload :Logger, 'zendesk2/logger'
   autoload :Model, 'zendesk2/model'

data/spec/groups_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "groups" do
+  let(:client) { create_client }
+  it_should_behave_like "a resource", :groups,
+    lambda { {name: Zendesk2.uuid} },
+    lambda { {name: Zendesk2.uuid} }
+
+  it "should list assignable groups" do
+    client.groups.create(name: Zendesk2.uuid) # assignable by default
+
+    client.groups.assignable.should be_all{|g| !g.deleted}
+  end
+end

data/spec/shared/resource.rb

@@ -12,7 +12,7 @@ shared_examples "a resource" do |_collection, _params, _update_params, _options|
 
   it "by fetching a specific record" do
     record = collection.create(params)
-    collection.get(*fetch_params.call(record)).should == record
+    collection.get(fetch_params.call(record)).should == record
   end
 
   context "that is paged" do

data/spec/topic_comments_spec.rb

@@ -5,12 +5,11 @@ describe "topic_comments" do
   let(:user)   { client.users.create(email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid, verified: true) }
   let(:forum)  { client.forums.create(name: Zendesk2.uuid) }
   let(:topic)  { client.topics.create(title: Zendesk2.uuid, body: Zendesk2.uuid, forum: forum) }
-  it_should_behave_like "a resource",
-    :topic_comments,
+  it_should_behave_like "a resource", :topic_comments,
     lambda { {body: Zendesk2.uuid, topic_id: topic.id, user_id: user.id} },
     lambda { {body: Zendesk2.uuid} },
     {
-      :fetch_params => lambda {|tc| [tc.topic_id, tc.id]},
+      :fetch_params => lambda {|tc| {"topic_id" => tc.topic_id, "id" => tc.id}},
       :collection   => lambda { client.topic_comments(topic_id: topic.id) },
     }
 end

data/spec/user_identities_spec.rb

@@ -8,7 +8,7 @@ describe "user_identities" do
     lambda { {value: "ey+#{Zendesk2.uuid}@example.org", type: "email", user_id: user.id} },
     lambda { {verified: true} },
     {
-      :fetch_params => lambda {|uc| [uc.user_id, uc.id]},
+      :fetch_params => lambda {|uc| {"user_id" => uc.user_id, "id" => uc.id}},
       :collection   => lambda { client.user_identities(user_id: user.id) },
     }
 end

data/zendesk2.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Zendesk2::VERSION
 
-  gem.add_dependency "cistern", "~> 0.1.3"
+  gem.add_dependency "cistern", "~> 0.2.0"
   gem.add_dependency "faraday"
   gem.add_dependency "faraday_middleware"
   gem.add_dependency "addressable"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-29 00:00:00.000000000 Z
+date: 2013-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cistern
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
     none: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
     none: false
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -98,6 +98,8 @@ files:
 - lib/zendesk2/client/models/category.rb
 - lib/zendesk2/client/models/forum.rb
 - lib/zendesk2/client/models/forums.rb
+- lib/zendesk2/client/models/group.rb
+- lib/zendesk2/client/models/groups.rb
 - lib/zendesk2/client/models/organization.rb
 - lib/zendesk2/client/models/organizations.rb
 - lib/zendesk2/client/models/ticket.rb
@@ -114,6 +116,7 @@ files:
 - lib/zendesk2/client/models/users.rb
 - lib/zendesk2/client/requests/create_category.rb
 - lib/zendesk2/client/requests/create_forum.rb
+- lib/zendesk2/client/requests/create_group.rb
 - lib/zendesk2/client/requests/create_organization.rb
 - lib/zendesk2/client/requests/create_ticket.rb
 - lib/zendesk2/client/requests/create_topic.rb
@@ -122,12 +125,14 @@ files:
 - lib/zendesk2/client/requests/create_user_identity.rb
 - lib/zendesk2/client/requests/destroy_category.rb
 - lib/zendesk2/client/requests/destroy_forum.rb
+- lib/zendesk2/client/requests/destroy_group.rb
 - lib/zendesk2/client/requests/destroy_organization.rb
 - lib/zendesk2/client/requests/destroy_ticket.rb
 - lib/zendesk2/client/requests/destroy_topic.rb
 - lib/zendesk2/client/requests/destroy_topic_comment.rb
 - lib/zendesk2/client/requests/destroy_user.rb
 - lib/zendesk2/client/requests/destroy_user_identity.rb
+- lib/zendesk2/client/requests/get_assignable_groups.rb
 - lib/zendesk2/client/requests/get_audits.rb
 - lib/zendesk2/client/requests/get_categories.rb
 - lib/zendesk2/client/requests/get_category.rb
@@ -135,6 +140,8 @@ files:
 - lib/zendesk2/client/requests/get_current_user.rb
 - lib/zendesk2/client/requests/get_forum.rb
 - lib/zendesk2/client/requests/get_forums.rb
+- lib/zendesk2/client/requests/get_group.rb
+- lib/zendesk2/client/requests/get_groups.rb
 - lib/zendesk2/client/requests/get_organization.rb
 - lib/zendesk2/client/requests/get_organization_tickets.rb
 - lib/zendesk2/client/requests/get_organization_users.rb
@@ -157,6 +164,7 @@ files:
 - lib/zendesk2/client/requests/search_user.rb
 - lib/zendesk2/client/requests/update_category.rb
 - lib/zendesk2/client/requests/update_forum.rb
+- lib/zendesk2/client/requests/update_group.rb
 - lib/zendesk2/client/requests/update_organization.rb
 - lib/zendesk2/client/requests/update_ticket.rb
 - lib/zendesk2/client/requests/update_topic.rb
@@ -167,11 +175,11 @@ files:
 - lib/zendesk2/error.rb
 - lib/zendesk2/logger.rb
 - lib/zendesk2/model.rb
-- lib/zendesk2/paged_collection.rb
 - lib/zendesk2/searchable.rb
 - lib/zendesk2/version.rb
 - spec/categories_spec.rb
 - spec/forums_spec.rb
+- spec/groups_spec.rb
 - spec/organizations_spec.rb
 - spec/shared/resource.rb
 - spec/spec_helper.rb
@@ -209,6 +217,7 @@ summary: Zendesk V2 API client
 test_files:
 - spec/categories_spec.rb
 - spec/forums_spec.rb
+- spec/groups_spec.rb
 - spec/organizations_spec.rb
 - spec/shared/resource.rb
 - spec/spec_helper.rb

data/lib/zendesk2/paged_collection.rb

@@ -1,41 +0,0 @@
-module Zendesk2::PagedCollection
-  def self.included(klass)
-    klass.send(:attribute, :count)
-    klass.send(:attribute, :next_page_link, {:aliases => "next_page"})
-    klass.send(:attribute, :previous_page_link, {:aliases => "previous_page"})
-    klass.send(:extend, Zendesk2::PagedCollection::Attributes)
-  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 all(params={})
-    body = connection.send(collection_method, params).body
-
-    collection = self.clone.load(body[collection_root])
-    collection.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
-    collection
-  end
-
-  def get(id)
-    if data = self.connection.send(model_method, {"id" => id}).body[self.model_root]
-      new(data)
-    end
-  rescue Zendesk2::Error
-    nil
-  end
-
-  def next_page
-    all("url" => next_page_link) if next_page_link
-  end
-
-  def previous_page
-    all("url" => previous_page_link) if previous_page_link
-  end
-
-  module Attributes
-    attr_accessor :collection_method, :collection_root, :model_method, :model_root
-  end
-end