zendesk2 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10b3b65c5dfd92a261f69f0a660ecf24a0127d5e
-  data.tar.gz: 1ad0fca09351198f8903b747905a8df3cd56d410
+  metadata.gz: a75f9d7681dd7fc05b70ffaac7cd40f4d7b0e0d2
+  data.tar.gz: da867a0ca54e8645a7ba70f301810474509dc640
 SHA512:
-  metadata.gz: b96383f2372c5fb600411c360a410fe798c3768226d2d1494fe9979b08f44f3f15376fc565bcd15ca41383e55c501001224b0e2a07fcd98dc7ec38ba8fae389d
-  data.tar.gz: 72d4a5e56f782f9ff7477d195405039bd91de6cbd797634669bedce9cce7180deecba16d69dbf5db3a42ede531585bd246cbc8ed49241ba1734fab88fa7d40b4
+  metadata.gz: 66a38be00688b1ee608f8898ac88cb96137f056a5eb116039f30ab143994dede0dbba3442c6bcae7503dc94d2d2f45b89a366624787fd2437c6129cc5cb3d354
+  data.tar.gz: 222bf38cead5cbbae73790862d893fbf7bccb1758d075980e03a7da722b7ce2b724d5c05fc8d364ab479a02a30efd9be892d30953349f8ed44be99c6fab1608c

data/Gemfile

@@ -15,5 +15,5 @@ group :test do
   gem 'awesome_print'
   gem 'guard-bundler', require: false
   gem 'guard-rspec', '~> 4.3', require: false
-  gem 'rspec', '~> 3.0'
+  gem 'rspec', '~> 3.2'
 end

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

@@ -17,4 +17,5 @@ class Zendesk2::Client::Organizations < Zendesk2::PagedCollection
   self.model_method      = :get_organization
   self.model_root        = "organization"
   self.search_type       = "organization"
+  self.search_request    = :search_organization
 end

data/lib/zendesk2/client/mock.rb

@@ -65,8 +65,12 @@ class Zendesk2::Client < Cistern::Service
       File.join(@url, path.to_s)
     end
 
-    def url_for(path)
-      File.join(@url, "/api/v2", path.to_s)
+    def url_for(path, options={})
+      Addressable::URI.parse(
+        File.join(@url, "/api/v2", path.to_s)
+      ).tap do |uri|
+        uri.query_values = options.fetch(:query, {})
+      end.to_s
     end
 
     def resources(collection, path, collection_root, options={})
@@ -86,7 +90,7 @@ class Zendesk2::Client < Cistern::Service
 
     def page(params, collection, path, collection_root, options={})
       page_params = Zendesk2.paging_parameters(params)
-      page_size   = (page_params["per_page"] || 50).to_i
+      page_size   = (page_params["per_page"] || 100).to_i
       page_index  = (page_params["page"] || 1).to_i
       offset      = (page_index - 1) * page_size
       filter      = options[:filter]
@@ -95,11 +99,13 @@ class Zendesk2::Client < Cistern::Service
       count       = resources.size
       total_pages = (count / page_size) + 1
 
+      query = options.fetch(:query, {})
+
       next_page = if page_index < total_pages
-                    url_for("#{path}?page=#{page_index + 1}&per_page=#{page_size}")
+                    url_for(path, query: {page: page_index + 1, per_page: page_size}.merge(query))
                   end
       previous_page = if page_index > 1
-                        url_for("#{path}?page=#{page_index - 1}&per_page=#{page_size}")
+                        url_for(path, query: {page: page_index - 1, per_page: page_size}.merge(query))
                       end
 
       resource_page = resources.slice(offset, page_size)

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

@@ -1,26 +1,23 @@
 class Zendesk2::Client
   class Real
-    def search(query)
+    def search(query, params={})
       request(
         :method => :get,
-        :params => {query: query},
+        :params => {query: query}.merge(params),
         :path   => "/search.json",
       )
     end
   end # Real
 
   class Mock
-    def search(query)
+    def search(query, params={})
       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.values.select { |v| terms.all?{ |term, condition| v[term.to_s].to_s == condition.to_s } }
 
-      response(
-        :path => "/search.json",
-        :body => {"results" => results},
-      )
+      page(params, nil, "/search.json", "results", resources: results, query: {query: query})
     end
   end # Mock
 end

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

@@ -1,26 +1,23 @@
 class Zendesk2::Client
   class Real
-    def search_help_center_articles(query)
+    def search_help_center_articles(query, params={})
       request(
         :method => :get,
-        :params => {query: query},
+        :params => {query: query}.merge(params),
         :path   => "/help_center/articles/search.json",
       )
     end
   end # Real
 
   class Mock
-    def search_help_center_articles(query)
+    def search_help_center_articles(query, params={})
       terms = Hash[query.split(" ").map { |t| t.split(":") }]
 
       collection = self.data[:help_center_articles].values
 
       results = collection.select { |v| terms.all?{ |term, condition| v[term.to_s].to_s == condition.to_s } }
 
-      response(
-        :path => "/search.json",
-        :body => {"results" => results},
-      )
+      page(params, :help_center_articles, "/search.json", "results", resources: results, query: {query: query})
     end
   end # Mock
 end

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

@@ -0,0 +1,36 @@
+class Zendesk2::Client
+  class Real
+    alias search_organization search
+  end # Real
+
+  class Mock
+    def search_organization(query, params={})
+      terms = Hash[query.split(" ").map { |t| t.split(":") }]
+      terms.delete("type") # context already provided
+
+      collection = self.data[:organizations].values
+
+      # organization name is fuzzy matched
+      if organization_name = terms.delete("name")
+        terms.merge!("name" => "*#{organization_name}*")
+      end
+
+      compiled_terms = terms.inject({}) do |r,(term, raw_condition)|
+        condition = if raw_condition.include?("*")
+                      Regexp.compile(raw_condition.gsub("*", ".*"), Regexp::IGNORECASE)
+                    else
+                      raw_condition
+                    end
+        r.merge(term => condition)
+      end
+
+      results = collection.select do |v|
+        compiled_terms.all? do |term, condition|
+          condition.is_a?(Regexp) ? condition.match(v[term.to_s]) : v[term.to_s].to_s == condition.to_s
+        end
+      end
+
+      page(params, :organizations, "/search.json", "results", resources: results, query: {query: query})
+    end
+  end # Mock
+end

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

@@ -4,7 +4,7 @@ class Zendesk2::Client
   end # Real
 
   class Mock
-    def search_user(query)
+    def search_user(query, params={})
       terms = Hash[query.split(" ").map { |t| t.split(":") }]
       terms.delete("type") # context already provided
 
@@ -46,10 +46,7 @@ class Zendesk2::Client
         end
       end
 
-      response(
-        :path => "/search.json",
-        :body => {"results" => results},
-      )
+      page(params, :users, "/search.json", "results", resources: results, query: {query: query})
     end
   end # Mock
 end

data/lib/zendesk2/paged_collection.rb

@@ -14,9 +14,8 @@ class Zendesk2::PagedCollection < Zendesk2::Collection
   def model_root; self.class.model_root; end
 
   def new_page
-    page = self.clone
-    %w[count next_page_link previous_page_link].each { |k| page.attributes.delete(k) }
-    page.records = []
+    page = self.class.new(connection: self.connection)
+    page.merge_attributes(self.class.scopes.inject({}){|r,k| r.merge(k.to_s => send(k))})
     page
   end
 
@@ -39,11 +38,11 @@ class Zendesk2::PagedCollection < Zendesk2::Collection
   end
 
   def next_page
-    new_page.all("url" => next_page_link) if next_page_link
+    new_page.all("url" => next_page_link, "filtered" => self.filtered) if next_page_link
   end
 
   def previous_page
-    new_page.all("url" => previous_page_link) if previous_page_link
+    new_page.all("url" => previous_page_link, "filtered" => self.filtered) if previous_page_link
   end
 
   # Attempt creation of resource and explode if unsuccessful
@@ -64,11 +63,17 @@ class Zendesk2::PagedCollection < Zendesk2::Collection
 
   # 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)
-    body = connection.send(collection_method, scoped_attributes).body
+    if params["filtered"] && (url = params["url"])
+      uri = Addressable::URI.parse(url)
+      query = uri.query_values
+      search(query.delete("query"), query)
+    else
+      scoped_attributes = self.class.scopes.inject({}){|r,k| r.merge(k.to_s => send(k))}.merge(params)
+      body = connection.send(collection_method, scoped_attributes).body
 
-    self.load(body[collection_root])
-    self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+      self.load(body[collection_root]) # 'results' is the key for paged seraches
+      self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+    end
     self
   end
 

data/lib/zendesk2/searchable.rb

@@ -1,6 +1,9 @@
 module Zendesk2::Searchable
   def self.included(klass)
     klass.send(:extend, Zendesk2::Searchable::Attributes)
+    # @note signal to underlying collection that a search request
+    #       must be use when requesting associated pages
+    klass.send(:attribute, :filtered, type: :boolean)
   end
 
   # Search for resources of a certain type.
@@ -14,7 +17,7 @@ module Zendesk2::Searchable
   #
   # @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)
+  def search(terms, params={})
     query = if terms.is_a?(Hash)
               terms.merge!("type" => self.class.search_type) if self.class.search_type
               terms.merge(self.class.scopes.inject({}){|r,k| r.merge(k.to_s => public_send(k))}).
@@ -33,12 +36,12 @@ module Zendesk2::Searchable
               end
             end
 
-    body = connection.send(self.class.search_request, query).body
+    body = connection.send(self.class.search_request, query, params).body
 
     if data = body.delete("results")
-      collection = self.clone.load(data)
-      collection.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
-      collection
+      self.load(data)
+      self.merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page").merge("filtered" => true))
+      self
     end
   end
 

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "1.4.1"
+  VERSION = "1.4.2"
 end

data/spec/lib/paged_collection_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Zendesk2::PagedCollection, :mock_only do
   let!(:client) { create_client }
 
-  let!(:records) { 333.times.map { client.organizations.create(name: mock_uuid) } }
+  let!(:records) { 333.times.each_with_index.map { |_,i| client.organizations.create(name: "#{i%3}_#{mock_uuid}") } }
 
   context "#each_page" do
     it "should enumerate pages" do
@@ -28,5 +28,15 @@ describe Zendesk2::PagedCollection, :mock_only do
 
       expect(target).to eq(found)
     end
+
+    it "should chain search paging" do
+      matching_records = records.select { |o| o.name.match(/\A2_/) }
+      expect(matching_records).not_to be_empty
+
+      found_records = client.organizations.search(name: "2_").each_entry.to_a
+
+      expect(matching_records.size).to eq(found_records.size)
+      expect(matching_records).to match_array(found_records)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -221,6 +221,7 @@ files:
 - lib/zendesk2/client/requests/mark_user_identity_primary.rb
 - lib/zendesk2/client/requests/search.rb
 - lib/zendesk2/client/requests/search_help_center_articles.rb
+- lib/zendesk2/client/requests/search_organization.rb
 - lib/zendesk2/client/requests/search_user.rb
 - lib/zendesk2/client/requests/update_category.rb
 - lib/zendesk2/client/requests/update_forum.rb
@@ -285,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Zendesk V2 API client
@@ -310,3 +311,4 @@ test_files:
 - spec/user_fields_spec.rb
 - spec/user_identities_spec.rb
 - spec/users_spec.rb
+has_rdoc: