zendesk2 1.0.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fb950fdc0ae118b3bba5edfb7a2729bec53561d
-  data.tar.gz: 2d427b0a21b5b0fdc8551013a2c76f1a36bf7587
+  metadata.gz: 270b2d17ca7f778a7021f68b64e4cbe4451f48bd
+  data.tar.gz: bd9144b1cc0adb733437334f62b60ed38daa6558
 SHA512:
-  metadata.gz: 4094b670f1a2f9e40a391ad70db20f3e5699b8eb1661d643d5a1e62ad80e0e81238470c67d7fa1d64e38f958b331ff4164bbe06f476b3329a8d0b144a087d6f4
-  data.tar.gz: 5f42f0d0fc4fe7948baf89c14c424ee31a4b3c0794fbf31302c1af80b37b25416b58488607d3afa369ba0ccb4e763b7574b92694570a5fad1d057ab95b5e1641
+  metadata.gz: 84675208061a34c5b10bffecc1f06b78f6842aa6c2503bfac0a916a565d6e080dbdba095906ff27d9cd00cbb41df663099ef1a86bd3d86ae3cbe5aaeb60c67e8
+  data.tar.gz: c3c62ea6e1ed67e048f2cefe75fec4f142846776063461730f2f89110b88d9fe8b081c49a785ba10f54a10147d27a796e4281fe188dd87c2024b523de92e2c0d

data/.travis.yml

@@ -1,11 +1,7 @@
 language: ruby
 rvm:
-  - "2.1.1"
+  - "2.1.2"
   - "1.9.3"
-  - "jruby-19mode"
-bundler_args: "--without development"
-before_install:
-  - "gem install bundler -v 1.5.2"
 script: "bundle exec rake --trace"
 notifications:
   email:

data/Gemfile

@@ -14,6 +14,6 @@ end
 group :test do
   gem 'awesome_print'
   gem 'guard-bundler', require: false
-  gem 'guard-rspec', '~> 4.2', require: false
-  gem 'rspec', '~> 2.99'
+  gem 'guard-rspec', '~> 4.3', require: false
+  gem 'rspec', '~> 3.0'
 end

data/Guardfile

@@ -3,7 +3,7 @@ guard 'bundler' do
   watch(/^.+\.gemspec/)
 end
 
-guard 'rspec', cmd: 'bundle exec rspec', all_on_start: true, all_after_pass: true do
+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" }

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Josh Lane
+Copyright (c) 2014 Josh Lane
 
 MIT License
 

data/README.md

@@ -37,7 +37,7 @@ Default credentials will be read in from `~/.zendesk2` file in YAML format.
 
 ```yaml
 ---
-:subdomain: zendeskdev
+:url: https://www.zendesk.com
 :username: zendeskedge@example.com
 :password: wickedsecurepassword
 :token: reallylongrandomstringprovidedbyzendesk
@@ -45,14 +45,7 @@ Default credentials will be read in from `~/.zendesk2` file in YAML format.
 
 ### Creating the client
 
-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")
-=> #<Zendesk2::Client::Real:0x007f99da1f9430 @url="https://engineyard.zendesk.com/api/v2", @username="orchestra", @password="gwoo", …>
-```
-
-or
+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")

data/Rakefile

@@ -2,6 +2,8 @@
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = "-cfd"
+end
 
 task :default => :spec

data/lib/zendesk2/client/{models → collections}/user_identities.rb

@@ -1,6 +1,4 @@
 class Zendesk2::Client::UserIdentities < Zendesk2::Collection
-  include Zendesk2::Searchable
-
   model Zendesk2::Client::UserIdentity
 
   attribute :user_id, type: :integer
@@ -9,7 +7,6 @@ class Zendesk2::Client::UserIdentities < Zendesk2::Collection
   self.collection_root   = "identities"
   self.model_method      = :get_user_identity
   self.model_root        = "identity"
-  self.search_type       = "identity"
 
   scopes << :user_id
 end

data/lib/zendesk2/client/mock.rb

@@ -0,0 +1,164 @@
+class Zendesk2::Client < Cistern::Service
+  class Mock
+    include Shared
+
+    attr_reader :username, :url, :token, :jwt_token
+
+    def self.data
+      @data ||= {
+        :categories      => {},
+        :forums          => {},
+        :groups          => {},
+        :identities      => {},
+        :memberships     => {},
+        :organizations   => {},
+        :ticket_audits   => {},
+        :ticket_comments => {},
+        :ticket_fields   => {},
+        :ticket_metrics  => {},
+        :tickets         => {},
+        :topic_comments  => {},
+        :topics          => {},
+        :user_fields     => {},
+        :users           => {},
+      }
+    end
+
+    def self.new_id
+      @current_id ||= 0
+      @current_id += 1
+    end
+
+    def data
+      self.class.data
+    end
+
+    def self.reset!
+      @data = nil
+    end
+
+    def initialize(options={})
+      @url                 = options[:url]
+      @path                = ::URI.parse(url).path
+      @username, @password = options[:username], options[:password]
+      @token               = options[:token]
+      @jwt_token           = options[:jwt_token]
+
+      @current_user ||= self.create_user("email" => @username, "name" => "Mock Agent").body["user"]
+      @current_user_identity ||= self.data[:identities].values.first
+    end
+
+    # Lazily re-seeds data after reset
+    # @return [Hash] current user response
+    def current_user
+      self.data[:users][@current_user["id"]] ||= @current_user
+      self.data[:identities][@current_user_identity["id"]] ||= @current_user_identity
+
+      @current_user
+    end
+
+    def url_for(path)
+      File.join(@url, "/api/v2", path.to_s)
+    end
+
+    def resources(collection, path, collection_root, options={})
+      filter    = options[:filter]
+      resources = self.data[collection].values
+      resources = filter.call(resources) if filter
+      count     = resources.size
+
+      response(
+        :body => {
+          collection_root => resources,
+          "count"         => count,
+        },
+        :path => path
+      )
+    end
+
+    def page(params, collection, path, collection_root, options={})
+      page_params = Zendesk2.paging_parameters(params)
+      page_size   = (page_params["per_page"] || 50).to_i
+      page_index  = (page_params["page"] || 1).to_i
+      offset      = (page_index - 1) * page_size
+      filter      = options[:filter]
+      resources   = self.data[collection].values
+      resources   = filter.call(resources) if filter
+      count       = resources.size
+      total_pages = (count / page_size) + 1
+
+      next_page = if page_index < total_pages
+                    url_for("#{path}?page=#{page_index + 1}&per_page=#{page_size}")
+                  end
+      previous_page = if page_index > 1
+                        url_for("#{path}?page=#{page_index - 1}&per_page=#{page_size}")
+                      end
+
+      resource_page = resources.slice(offset, page_size)
+
+      body = {
+        collection_root => resource_page,
+        "count"         => count,
+        "next_page"     => next_page,
+        "previous_page" => previous_page,
+      }
+
+      response(
+        :body => body,
+        :path => path
+      )
+    end
+
+    def pluralize(word)
+      pluralized = word.dup
+      [[/y$/, 'ies'], [/$/, 's']].find{|regex, replace| pluralized.gsub!(regex, replace) if pluralized.match(regex)}
+      pluralized
+    end
+
+    def self.error_map
+      @@error_map ||= {
+        :invalid => [422, {
+          "error"       => "RecordInvalid",
+          "description" => "Record validation errors",
+        }],
+        :not_found => [404, {
+          "error"       => "RecordNotFound",
+          "description" => "Not found",
+        }],
+      }
+    end
+
+    def find!(collection, identity, options={})
+      if resource = self.data[collection][identity]
+        resource
+      else
+        error!(options[:error] || :not_found)
+      end
+    end
+
+    def error!(type, options={})
+      status, body = self.class.error_map[type]
+      body.merge!("details" => options[:details]) if options[:details]
+
+      response(
+        :status => status,
+        :body   => body,
+      )
+    end
+
+    def response(options={})
+      method = options[:method] || :get
+      status = options[:status] || 200
+      path   = options[:path]
+      body   = options[:body]
+
+      url = options[:url] || url_for(path)
+
+      env = Faraday::Env.new(method, body, url, nil, {}, nil, nil, {}, nil, {"Content-Type"  => "application/json; charset=utf-8"}, status)
+
+      Faraday::Response::RaiseError.new.on_complete(env) || Faraday::Response.new(env)
+    rescue Faraday::Error::ClientError => e
+      raise Zendesk2::Error.new(e)
+    end
+  end
+end

data/lib/zendesk2/client/real.rb

@@ -0,0 +1,60 @@
+class Zendesk2::Client < Cistern::Service
+  class Real
+    include Zendesk2::Client::Shared
+
+    attr_accessor :username, :url, :token, :logger, :jwt_token
+
+    def initialize(options={})
+      @url = if url = options[:url] || Zendesk2.defaults[:url]
+               ::URI.parse(url).to_s
+             end
+
+      @logger   = options[:logger]   || Logger.new(nil)
+      adapter   = options[:adapter]  || Faraday.default_adapter
+      @username = options[:username] || Zendesk2.defaults[:username]
+      @token    = options[:token]    || Zendesk2.defaults[:token]
+      password  = options[:password] || Zendesk2.defaults[:password]
+
+      connection_options = options[:connection_options] || {}
+
+      @auth_token  = password || @token
+      @username   += "/token" if @auth_token == @token
+      @jwt_token   = options[:jwt_token]
+
+      raise "Missing required options: :url" unless @url
+      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, @auth_token
+        builder.use Faraday::Response::RaiseError
+        builder.response :json
+
+        # request
+        builder.request :multipart
+        builder.request :json
+
+        builder.use Zendesk2::Logger, @logger
+        builder.adapter adapter
+      end
+    end
+
+    def request(options={})
+      method  = options[:method] || :get
+      url     = options[:url] || File.join(@url, "/api/v2", options[:path])
+      params  = options[:params] || {}
+      body    = options[:body]
+      headers = {"User-Agent" => USER_AGENT}.merge(options[:headers] || {})
+
+      @connection.send(method) do |req|
+        req.url url
+        req.headers.merge!(headers)
+        req.params.merge!(params)
+        req.body = body
+      end
+    rescue Faraday::Error::ClientError => e
+      raise Zendesk2::Error.new(e)
+    end
+  end
+end

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

@@ -52,7 +52,7 @@ class Zendesk2::Client
             "details"     => {
               "name" => [
                 {
-                  "description" => "Name has already been taken"
+                  "description" => "Name: has already been taken"
                 }
               ]
             }

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

@@ -43,7 +43,7 @@ class Zendesk2::Client
         }
 
         self.data[:identities][user_identity_id] = user_identity
-        self.data[:users][user_id] = record.reject{|k,v| k == "email"}
+        self.data[:users][user_id] = record.reject { |k,v| k == "email" }
 
         response(
           :method => :post,

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

@@ -13,6 +13,8 @@ class Zendesk2::Client
 
   class Mock
     def create_user_identity(params={})
+      params = Cistern::Hash.stringify_keys(params)
+
       identity = self.class.new_id
       user_id  = params["user_id"]
 
@@ -25,7 +27,11 @@ class Zendesk2::Client
         "primary"    => false,
       }.merge(params)
 
-      record.merge("primary" => true) if self.data[:identities].values.find{|ui| ui["user_id"] == user_id}.nil?
+      record.merge("primary" => true) if self.data[:identities].values.find { |ui| ui["user_id"] == user_id }.nil?
+
+      if self.data[:identities].values.find { |i| i["value"] == record["value"] }
+        error!(:invalid, details: { "value"=> [ { "description"=>"Value: #{record["value"]} is already being used by another user" } ] })
+      end
 
       self.data[:identities][identity] = record
 

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

@@ -1,10 +1,9 @@
 class Zendesk2::Client
   class Real
     def search(query)
-      term = query.map{|k,v| "#{k}:#{v}"}.join(" ")
       request(
         :method => :get,
-        :params => {query: term},
+        :params => {query: query},
         :path   => "/search.json",
       )
     end
@@ -12,10 +11,11 @@ class Zendesk2::Client
 
   class Mock
     def search(query)
-      type       = query.delete("type")
+      terms = Hash[query.split(" ").map { |t| t.split(":") }]
+      type = terms.delete("type")
       collection = type.nil? ? self.data.values : self.data[pluralize(type).to_sym]
 
-      results = collection.select{|k,v| query.all?{|term, condition| v[term.to_s] == condition}}.values
+      results = collection.values.select { |v| terms.all?{ |term, condition| v[term.to_s].to_s == condition.to_s } }
 
       response(
         :path => "/search.json",

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

@@ -5,7 +5,8 @@ class Zendesk2::Client
 
   class Mock
     def search_user(query)
-      query.delete("type") # context already provided
+      terms = Hash[query.split(" ").map { |t| t.split(":") }]
+      terms.delete("type") # context already provided
 
       collection = self.data[:users].values
       collection = collection.map do |user|
@@ -14,7 +15,7 @@ class Zendesk2::Client
         end
       end.flatten
 
-      results = collection.select{|v| query.all?{|term, condition| v[term.to_s] == condition}}
+      results = collection.select { |v| terms.all?{ |term, condition| v[term.to_s].to_s == condition.to_s } }
 
       response(
         :path => "/search.json",

data/lib/zendesk2/client.rb

@@ -1,125 +1,20 @@
 class Zendesk2::Client < Cistern::Service
   USER_AGENT = "Ruby/#{RUBY_VERSION} (#{RUBY_PLATFORM}; #{RUBY_ENGINE}) Zendesk2/#{Zendesk2::VERSION} Faraday/#{Faraday::VERSION}".freeze
 
-  model_path "zendesk2/client/models"
-  request_path "zendesk2/client/requests"
-
-  require 'zendesk2/client/models/audit_event' # so special
-
-  collection :categories
-  collection :forums
-  collection :groups
-  collection :memberships
-  collection :organizations
-  collection :ticket_audits
-  collection :ticket_fields
-  collection :ticket_metrics
-  collection :tickets
-  collection :ticket_comments
-  collection :topic_comments
-  collection :topics
-  collection :user_fields
-  collection :user_identities
-  collection :users
-  model :category
-  model :forum
-  model :group
-  model :membership
-  model :organization
-  model :ticket
-  model :ticket_audit
-  model :ticket_metric
-  model :ticket_change
-  model :ticket_comment
-  model :ticket_comment_privacy_change
-  model :ticket_create
-  model :ticket_field
-  model :ticket_notification
-  model :ticket_voice_comment
-  model :topic
-  model :topic_comment
-  model :user
-  model :user_field
-  model :user_identity
-
-  request :create_category
-  request :create_forum
-  request :create_group
-  request :create_membership
-  request :create_organization
-  request :create_ticket
-  request :create_ticket_field
-  request :create_topic
-  request :create_topic_comment
-  request :create_user
-  request :create_user_field
-  request :create_user_identity
-  request :destroy_category
-  request :destroy_forum
-  request :destroy_group
-  request :destroy_membership
-  request :destroy_organization
-  request :destroy_ticket
-  request :destroy_ticket_field
-  request :destroy_topic
-  request :destroy_topic_comment
-  request :destroy_user
-  request :destroy_user_field
-  request :destroy_user_identity
-  request :get_assignable_groups
-  request :get_audits
-  request :get_categories
-  request :get_category
-  request :get_ccd_tickets
-  request :get_current_user
-  request :get_forum
-  request :get_forums
-  request :get_group
-  request :get_groups
-  request :get_membership
-  request :get_organization
-  request :get_organization_by_external_id
-  request :get_organization_memberships
-  request :get_organization_tickets
-  request :get_organization_users
-  request :get_organizations
-  request :get_requested_tickets
-  request :get_ticket
-  request :get_ticket_audit
-  request :get_ticket_audits
-  request :get_ticket_comments
-  request :get_ticket_field
-  request :get_ticket_fields
-  request :get_ticket_metric
-  request :get_ticket_metrics
-  request :get_tickets
-  request :get_topic
-  request :get_topic_comment
-  request :get_topic_comments
-  request :get_topics
-  request :get_user
-  request :get_user_field
-  request :get_user_fields
-  request :get_user_identities
-  request :get_user_identity
-  request :get_user_memberships
-  request :get_users
-  request :mark_membership_default
-  request :mark_user_identity_primary
-  request :search
-  request :search_user
-  request :update_category
-  request :update_forum
-  request :update_group
-  request :update_organization
-  request :update_request
-  request :update_ticket
-  request :update_ticket_field
-  request :update_topic
-  request :update_topic_comment
-  request :update_user
-  request :update_user_field
-  request :update_user_identity
+  collection_path "zendesk2/client/collections"
+  model_path      "zendesk2/client/models"
+  request_path    "zendesk2/client/requests"
+
+  # might be nice if cistern took care of this
+  [
+    [:collection, collection_path],
+    [:model,      model_path],
+    [:request,    request_path],
+  ].each do |type, path|
+    Dir[File.expand_path(File.join("../..", path, "*.rb"), __FILE__)].sort.each do |file|
+      send(type, File.basename(file, ".rb"))
+    end
+  end
 
   recognizes :url, :logger, :adapter, :username, :password, :token, :jwt_token
 
@@ -130,226 +25,7 @@ class Zendesk2::Client < Cistern::Service
       end
     end
   end
-
-  class Real
-    include Shared
-
-    attr_accessor :username, :url, :token, :logger, :jwt_token
-
-    def initialize(options={})
-      @url = if url = options[:url] || Zendesk2.defaults[:url]
-               ::URI.parse(url).to_s
-             end
-
-      @logger   = options[:logger]   || Logger.new(nil)
-      adapter   = options[:adapter]  || Faraday.default_adapter
-      @username = options[:username] || Zendesk2.defaults[:username]
-      @token    = options[:token]    || Zendesk2.defaults[:token]
-      password  = options[:password] || Zendesk2.defaults[:password]
-
-      connection_options = options[:connection_options] || {}
-
-      @auth_token  = password || @token
-      @username   += "/token" if @auth_token == @token
-      @jwt_token   = options[:jwt_token]
-
-      raise "Missing required options: :url" unless @url
-      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, @auth_token
-        builder.use Faraday::Response::RaiseError
-        builder.response :json
-
-        # request
-        builder.request :multipart
-        builder.request :json
-
-        builder.use Zendesk2::Logger, @logger
-        builder.adapter adapter
-      end
-    end
-
-    def request(options={})
-      method  = options[:method] || :get
-      url     = options[:url] || File.join(@url, "/api/v2", options[:path])
-      params  = options[:params] || {}
-      body    = options[:body]
-      headers = {"User-Agent" => USER_AGENT}.merge(options[:headers] || {})
-
-      @connection.send(method) do |req|
-        req.url url
-        req.headers.merge!(headers)
-        req.params.merge!(params)
-        req.body = body
-      end
-    rescue Faraday::Error::ClientError => e
-      raise Zendesk2::Error.new(e)
-    end
-  end
-
-  class Mock
-    include Shared
-
-    attr_reader :username, :url, :token, :jwt_token
-
-    def self.data
-      @data ||= {
-        :categories      => {},
-        :forums          => {},
-        :groups          => {},
-        :identities      => {},
-        :memberships     => {},
-        :organizations   => {},
-        :ticket_audits   => {},
-        :ticket_comments => {},
-        :ticket_fields   => {},
-        :ticket_metrics  => {},
-        :tickets         => {},
-        :topic_comments  => {},
-        :topics          => {},
-        :user_fields     => {},
-        :users           => {},
-      }
-    end
-
-    def self.new_id
-      @current_id ||= 0
-      @current_id += 1
-    end
-
-    def data
-      self.class.data
-    end
-
-    def self.reset!
-      @data = nil
-    end
-
-    def initialize(options={})
-      @url  = options[:url]
-      @path = ::URI.parse(url).path
-      @username, @password = options[:username], options[:password]
-      @token = options[:token]
-      @jwt_token = options[:jwt_token]
-
-      @current_user ||= self.create_user("email" => @username, "name" => "Mock Agent").body["user"]
-      @current_user_identity ||= self.data[:identities].values.first
-    end
-
-    # Lazily re-seeds data after reset
-    # @return [Hash] current user response
-    def current_user
-      self.data[:users][@current_user["id"]] ||= @current_user
-      self.data[:identities][@current_user_identity["id"]] ||= @current_user_identity
-
-      @current_user
-    end
-
-    def url_for(path)
-      File.join(@url, "/api/v2", path.to_s)
-    end
-
-    def resources(collection, path, collection_root, options={})
-      filter    = options[:filter]
-      resources = self.data[collection].values
-      resources = filter.call(resources) if filter
-      count     = resources.size
-
-      response(
-        :body => {
-          collection_root => resources,
-          "count"         => count,
-        },
-        :path => path
-      )
-    end
-
-    def page(params, collection, path, collection_root, options={})
-      page_params = Zendesk2.paging_parameters(params)
-      page_size   = (page_params["per_page"] || 50).to_i
-      page_index  = (page_params["page"] || 1).to_i
-      offset      = (page_index - 1) * page_size
-      filter      = options[:filter]
-      resources   = self.data[collection].values
-      resources   = filter.call(resources) if filter
-      count       = resources.size
-      total_pages = (count / page_size) + 1
-
-      next_page = if page_index < total_pages
-                    url_for("#{path}?page=#{page_index + 1}&per_page=#{page_size}")
-                  end
-      previous_page = if page_index > 1
-                        url_for("#{path}?page=#{page_index - 1}&per_page=#{page_size}")
-                      end
-
-      resource_page = resources.slice(offset, page_size)
-
-      body = {
-        collection_root => resource_page,
-        "count"         => count,
-        "next_page"     => next_page,
-        "previous_page" => previous_page,
-      }
-
-      response(
-        :body => body,
-        :path => path
-      )
-    end
-
-    def pluralize(word)
-      pluralized = word.dup
-      [[/y$/, 'ies'], [/$/, 's']].find{|regex, replace| pluralized.gsub!(regex, replace) if pluralized.match(regex)}
-      pluralized
-    end
-
-    def self.error_map
-      @@error_map ||= {
-        :invalid => [422, {
-          "error"       => "RecordInvalid",
-          "description" => "Record validation errors",
-        }],
-        :not_found => [404, {
-          "error"       => "RecordNotFound",
-          "description" => "Not found",
-        }],
-      }
-    end
-
-    def find!(collection, identity, options={})
-      if resource = self.data[collection][identity]
-        resource
-      else
-        error!(options[:error] || :not_found)
-      end
-    end
-
-    def error!(type, options={})
-      status, body = self.class.error_map[type]
-      body.merge!("details" => options[:details]) if options[:details]
-
-      response(
-        :status => status,
-        :body   => body,
-      )
-    end
-
-    def response(options={})
-      method = options[:method] || :get
-      status = options[:status] || 200
-      path   = options[:path]
-      body   = options[:body]
-
-      url = options[:url] || url_for(path)
-
-      env = Faraday::Env.new(method, body, url, nil, {}, nil, nil, {}, nil, {"Content-Type"  => "application/json; charset=utf-8"}, status)
-
-      Faraday::Response::RaiseError.new.on_complete(env) || Faraday::Response.new(env)
-    rescue Faraday::Error::ClientError => e
-      raise Zendesk2::Error.new(e)
-    end
-  end
 end
+
+require 'zendesk2/client/real'
+require 'zendesk2/client/mock'

data/lib/zendesk2/searchable.rb

@@ -3,8 +3,37 @@ module Zendesk2::Searchable
     klass.send(:extend, Zendesk2::Searchable::Attributes)
   end
 
-  def search(parameters)
-    body = connection.send(self.class.search_request, parameters.merge("type" => self.class.search_type)).body
+  # Search for resources of a certain type.
+  #
+  # If you need more control over your search (see Zendesk2::Client::Real#search)
+  #
+  # @example search with a simple hash
+  #   client.users.search("email" => "jlane@engineyard.com")
+  # @example search with fully qualified query
+  #   client.tickets.search("created>2012-06-17+type:ticket+organization:'Mondocam Photo'")
+  #
+  # @param [String, Hash] seach terms.  This will be converted to a qualified Zendesk search String
+  # @see http://developer.zendesk.com/documentation/rest_api/search.html
+  def search(terms)
+    query = if terms.is_a?(Hash)
+              terms.merge("type" => self.class.search_type).
+                merge(self.class.scopes.inject({}){|r,k| r.merge(k.to_s => public_send(k))}).
+                map { |k,v| "#{k}:#{v}" }.join(" ")
+            else
+              additional_terms = ["type:#{self.class.search_type}"]
+              additional_terms += self.class.scopes.inject([]) { |r,k| ["#{k}:#{public_send(k)}"] }
+
+              additional_terms.inject(terms.to_s) do |qualified_search, qualification|
+                if !qualified_search.include?(qualification)
+                  "#{qualified_search} #{qualification}"
+                else
+                  qualified_search
+                end
+              end
+            end
+
+    body = connection.send(self.class.search_request, query).body
+
     if data = body.delete("results")
       collection = self.clone.load(data)
       collection.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "1.0.0"
+  VERSION = "1.1.2"
 end

data/lib/zendesk2.rb

@@ -15,16 +15,6 @@ require 'yaml'
 require 'uri'
 
 module Zendesk2
-  require 'zendesk2/attributes'
-  require 'zendesk2/attributes'
-  require 'zendesk2/error'
-  require 'zendesk2/client'
-  require 'zendesk2/searchable'
-  require 'zendesk2/logger'
-  require 'zendesk2/model'
-  require 'zendesk2/collection'
-  require 'zendesk2/paged_collection'
-
   def self.defaults
     @defaults ||= if File.exists?(File.expand_path("~/.zendesk2"))
                     YAML.load_file(File.expand_path("~/.zendesk2"))
@@ -54,3 +44,13 @@ module Zendesk2
     string.nil? || string == ""
   end
 end
+
+require 'zendesk2/attributes'
+require 'zendesk2/error'
+require 'zendesk2/searchable'
+require 'zendesk2/logger'
+require 'zendesk2/model'
+require 'zendesk2/collection'
+require 'zendesk2/paged_collection'
+
+require 'zendesk2/client'

data/spec/organizations_spec.rb

@@ -25,7 +25,7 @@ describe "organizations" do
     it "should hate non-unique names" do
       expect { client.organizations.create!(name: organization.name) }.to raise_exception(Zendesk2::Error)
       model = client.organizations.create(name: organization.name)
-      expect(model.errors).to eq({"name" => ["Name has already been taken"]})
+      expect(model.errors).to eq({"name" => ["Name: has already been taken"]})
     end
 
     it "should be able to find organizations by external id" do

data/spec/shared/zendesk_resource.rb

@@ -4,6 +4,7 @@ shared_examples "zendesk resource" do |options={}|
     let(:create_params) { instance_exec(&options[:create_params]) || {} }
     let(:update_params) { instance_exec(&options[:update_params]) }
     let(:fetch_params)  { options[:fetch_params] || lambda { |r| r.identity } }
+    let(:search_params) { options[:search_params] ? instance_exec(&options[:search_params]) : create_params }
 
     let(:record) { @record }
     after(:each) { @record && @record.destroy }
@@ -73,9 +74,14 @@ shared_examples "zendesk resource" do |options={}|
 
     if options.fetch(:search, true) && Zendesk2::Client.mocking?
       # Search index takes 2-3 minutes according to the docs
-      it "should search" do
+      it "should search by hash" do
         @record = collection.create!(create_params)
-        expect(collection.search(create_params)).to include(record)
+        expect(collection.search(search_params).to_a).to eq([record])
+      end
+
+      it "should search by string" do
+        @record = collection.create!(create_params)
+        expect(collection.search(search_params.map { |k,v| [k,v].join(":") }.join(" ")).to_a).to eq([record])
       end
     end
   end

data/spec/support/client_helper.rb

@@ -3,7 +3,12 @@ require 'logger'
 module ClientHelper
   def create_client(options={})
     options.merge!(logger: Logger.new(STDOUT)) if ENV['VERBOSE']
-    options = {username: "zendesk2@example.org", password: "password"}.merge(Zendesk2.defaults).merge(options)
+    options = {
+      :username => "zendesk2@example.org",
+      :password => "password",
+      :url      => "https://www.zendesk.com",
+    }.merge(Zendesk2.defaults).merge(options)
+
     Zendesk2::Client.new(options)
   end
 end

data/spec/tickets_spec.rb

@@ -3,11 +3,13 @@ require 'spec_helper'
 describe "Zendesk2::Client" do
   let(:client) { create_client }
 
-  include_examples "zendesk resource", {
-    :collection => lambda { client.tickets },
-    :create_params => lambda { {subject: Zendesk2.uuid, description: Zendesk2.uuid} },
-    :update_params => lambda { {subject: Zendesk2.uuid} },
-  }
+  describe "tickets" do
+    include_examples "zendesk resource", {
+      :collection    => lambda { client.tickets },
+      :create_params => lambda { {subject: Zendesk2.uuid, description: Zendesk2.uuid} },
+      :update_params => lambda { {subject: Zendesk2.uuid} },
+    }
+  end
 
   describe "#create_ticket" do
     it "should require a description" do
@@ -74,7 +76,7 @@ describe "Zendesk2::Client" do
     end
   end
 
-  describe "comments" do
+  describe "ticket comments" do
     let(:ticket) { client.tickets.create!(subject: Zendesk2.uuid, description: Zendesk2.uuid) }
 
     it "lists audits" do
@@ -85,7 +87,10 @@ describe "Zendesk2::Client" do
       expect(audit.ticket).to eq(ticket)
 
       events = audit.events
-      expect(events.size).to eq(1)
+
+      if Zendesk2::Client.mocking?
+        expect(events.size).to eq(1)
+      end
 
       event = events.first
       expect(event.body).to eq(body)
@@ -101,7 +106,7 @@ describe "Zendesk2::Client" do
     end
   end
 
-  describe "custom fields" do
+  describe "ticket custom fields" do
     let!(:ticket_field) { client.ticket_fields.create!(title: SecureRandom.hex(3), type: "text") }
 
     it "should be based on ticket_fields" do

data/spec/user_identities_spec.rb

@@ -5,10 +5,27 @@ describe "user_identities" do
   let(:user)   { client.users.create(email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid, verified: true) }
 
   include_examples "zendesk resource", {
-      :create_params => lambda { { value: "ey+#{Zendesk2.uuid}@example.org", type: "email", user_id: user.id } },
-      :update_params => lambda { { verified: true } },
-      :fetch_params  => lambda { |uc| { "user_id" => uc.user_id, "id" => uc.id } },
-      :collection    => lambda { client.user_identities(user_id: user.id) },
-      :paged         => false,
-    }
+    :create_params => lambda { { value: "ey+#{Zendesk2.uuid}@example.org", type: "email", user_id: user.id } },
+    :update_params => lambda { { verified: true } },
+    :fetch_params  => lambda { |uc| { "user_id" => uc.user_id, "id" => uc.id } },
+    :collection    => lambda { client.user_identities(user_id: user.id) },
+    :paged         => false,
+    :search        => false,
+  }
+
+  describe "#create_user_identity" do
+    let(:another_user) { client.users.create(email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid, verified: true) }
+
+    it "should prevent duplicate identities across users" do
+      expect {
+        client.create_user_identity("type" => "email", "value" => user.email, "user_id" => another_user.id)
+      }.to raise_exception(Zendesk2::Error, /is already being used by another user/)
+    end
+
+    it "should prevent duplicate identities on the same user" do
+      expect {
+        client.create_user_identity("type" => "email", "value" => user.email, "user_id" => user.id)
+      }.to raise_exception(Zendesk2::Error, /is already being used by another user/)
+    end
+  end
 end

data/spec/users_spec.rb

@@ -34,7 +34,7 @@ describe "users" do
       expect(user.requested_tickets).to include ticket
     end
 
-    it "should get ccd tickets" do
+    it "should get ccd tickets", mock_only: true do
       ticket = client.tickets.create(collaborators: [user], subject: Zendesk2.uuid, description: Zendesk2.uuid)
 
       expect(user.ccd_tickets).to include ticket

data/zendesk2.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.version       = Zendesk2::VERSION
 
   gem.add_dependency "addressable", "~> 2.2"
-  gem.add_dependency "cistern", "~> 0.6"
+  gem.add_dependency "cistern", "~> 0.9", ">= 0.9.2"
   gem.add_dependency "faraday", "~> 0.9"
   gem.add_dependency "faraday_middleware", "~> 0.9"
   gem.add_dependency "jwt", "~> 1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-26 00:00:00.000000000 Z
+date: 2014-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,14 +30,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -91,7 +97,6 @@ files:
 - ".travis.yml"
 - Gemfile
 - Guardfile
-- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -99,42 +104,44 @@ files:
 - lib/zendesk2.rb
 - lib/zendesk2/attributes.rb
 - lib/zendesk2/client.rb
+- lib/zendesk2/client/collections/categories.rb
+- lib/zendesk2/client/collections/forums.rb
+- lib/zendesk2/client/collections/groups.rb
+- lib/zendesk2/client/collections/memberships.rb
+- lib/zendesk2/client/collections/organizations.rb
+- lib/zendesk2/client/collections/ticket_audits.rb
+- lib/zendesk2/client/collections/ticket_comments.rb
+- lib/zendesk2/client/collections/ticket_fields.rb
+- lib/zendesk2/client/collections/ticket_metrics.rb
+- lib/zendesk2/client/collections/tickets.rb
+- lib/zendesk2/client/collections/topic_comments.rb
+- lib/zendesk2/client/collections/topics.rb
+- lib/zendesk2/client/collections/user_fields.rb
+- lib/zendesk2/client/collections/user_identities.rb
+- lib/zendesk2/client/collections/users.rb
+- lib/zendesk2/client/mock.rb
 - lib/zendesk2/client/models/audit_event.rb
-- lib/zendesk2/client/models/categories.rb
 - 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/membership.rb
-- lib/zendesk2/client/models/memberships.rb
 - lib/zendesk2/client/models/organization.rb
-- lib/zendesk2/client/models/organizations.rb
 - lib/zendesk2/client/models/ticket.rb
 - lib/zendesk2/client/models/ticket_audit.rb
-- lib/zendesk2/client/models/ticket_audits.rb
 - lib/zendesk2/client/models/ticket_change.rb
 - lib/zendesk2/client/models/ticket_comment.rb
 - lib/zendesk2/client/models/ticket_comment_privacy_change.rb
-- lib/zendesk2/client/models/ticket_comments.rb
 - lib/zendesk2/client/models/ticket_create.rb
 - lib/zendesk2/client/models/ticket_field.rb
-- lib/zendesk2/client/models/ticket_fields.rb
 - lib/zendesk2/client/models/ticket_metric.rb
-- lib/zendesk2/client/models/ticket_metrics.rb
 - lib/zendesk2/client/models/ticket_notification.rb
 - lib/zendesk2/client/models/ticket_voice_comment.rb
-- lib/zendesk2/client/models/tickets.rb
 - lib/zendesk2/client/models/topic.rb
 - lib/zendesk2/client/models/topic_comment.rb
-- lib/zendesk2/client/models/topic_comments.rb
-- lib/zendesk2/client/models/topics.rb
 - lib/zendesk2/client/models/user.rb
 - lib/zendesk2/client/models/user_field.rb
-- lib/zendesk2/client/models/user_fields.rb
-- lib/zendesk2/client/models/user_identities.rb
 - lib/zendesk2/client/models/user_identity.rb
-- lib/zendesk2/client/models/users.rb
+- lib/zendesk2/client/real.rb
 - lib/zendesk2/client/requests/create_category.rb
 - lib/zendesk2/client/requests/create_forum.rb
 - lib/zendesk2/client/requests/create_group.rb
@@ -276,4 +283,3 @@ test_files:
 - spec/user_fields_spec.rb
 - spec/user_identities_spec.rb
 - spec/users_spec.rb
-has_rdoc: 

data/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2012 Josh Lane
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.