zendesk_api 0.1.11 → 0.2.1

data/.gitignore

@@ -6,3 +6,6 @@ spec/fixtures/credentials.yml
 coverage
 .yardoc
 example.rb
+bin/*.yml
+.sass-cache
+config/mongod

data/.travis.yml

@@ -3,6 +3,4 @@ rvm:
   - 1.9.2
   - 1.9.3
   - jruby
-branches:
-  except:
-    - zendesk_console
+bundler_args: --without=server console

data/Gemfile

@@ -5,4 +5,28 @@ gem "jruby-openssl", :platforms => :jruby
 gem "hashie", :git => "git://github.com/intridea/hashie.git"
 gem "multipart-post", :git => "git://github.com/steved555/multipart-post.git"
 
+group :server do
+  gem "rack-ssl-enforcer"
+
+  gem "sinatra"
+  gem "sinatra-contrib"
+
+  gem "haml"
+
+  gem "compass"
+  gem "bootstrap-sass"
+
+  gem "coderay"
+  gem "coderay_bash"
+
+  gem "redcarpet"
+
+  gem "mongoid"
+  gem "database_cleaner"
+end
+
+group :console do
+  gem "ripl"
+end
+
 gemspec

data/Gemfile.lock

@@ -6,14 +6,14 @@ GIT
 
 GIT
   remote: git://github.com/steved555/multipart-post.git
-  revision: f5bc9450fad3895542a7cf18dbdd9af4ba5ab031
+  revision: 57c66998c05143a684c13694937c8adfd335cae1
   specs:
     multipart-post (1.1.5)
 
 PATH
   remote: .
   specs:
-    zendesk_api (0.1.11)
+    zendesk_api (0.2.0)
       faraday (>= 0.8.0)
       faraday_middleware (>= 0.8.7)
       hashie
@@ -25,19 +25,58 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
     addressable (2.3.2)
-    bump (0.3.3)
+    backports (2.6.5)
+    bond (0.4.2)
+    bootstrap-sass (2.1.1.0)
+    builder (3.0.4)
+    bump (0.3.5)
+    chunky_png (1.2.6)
+    coderay (1.0.8)
+    coderay_bash (1.0.4)
+      coderay (>= 1.0)
+    compass (0.12.2)
+      chunky_png (~> 1.2)
+      fssm (>= 0.2.7)
+      sass (~> 3.1)
     crack (0.3.1)
+    database_cleaner (0.9.1)
     diff-lcs (1.1.3)
+    eventmachine (1.0.0)
     faraday (0.8.4)
       multipart-post (~> 1.1)
     faraday_middleware (0.9.0)
       faraday (>= 0.7.4, < 0.9)
+    fssm (0.2.9)
+    haml (3.1.7)
+    i18n (0.6.1)
     inflection (1.0.0)
     json (1.7.5)
     mime-types (1.19)
-    multi_json (1.3.6)
+    mongoid (3.0.11)
+      activemodel (~> 3.1)
+      moped (~> 1.1)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.2.8)
+    multi_json (1.3.7)
+    origin (1.0.10)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rack-ssl-enforcer (0.2.4)
+    rack-test (0.6.2)
+      rack (>= 1.0)
     rake (0.9.2.2)
+    redcarpet (2.2.2)
+    ripl (0.7.0)
+      bond (~> 0.4.2)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
@@ -46,27 +85,53 @@ GEM
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.3)
-    simplecov (0.6.4)
+    sass (3.2.2)
+    simplecov (0.7.1)
       multi_json (~> 1.0)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
-    vcr (2.2.5)
-    webmock (1.8.11)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sinatra (1.3.3)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    sinatra-contrib (1.3.2)
+      backports (>= 2.0)
+      eventmachine
+      rack-protection
+      rack-test
+      sinatra (~> 1.3.0)
+      tilt (~> 1.3)
+    tilt (1.3.3)
+    tzinfo (0.3.35)
+    vcr (2.3.0)
+    webmock (1.9.0)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
-    yard (0.8.2.1)
+    yard (0.8.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bootstrap-sass
   bump
+  coderay
+  coderay_bash
+  compass
+  database_cleaner
+  haml
   hashie!
   jruby-openssl
+  mongoid
   multipart-post!
+  rack-ssl-enforcer
   rake
+  redcarpet
+  ripl
   rspec
   simplecov
+  sinatra
+  sinatra-contrib
   vcr
   webmock
   yard

data/Procfile

@@ -0,0 +1 @@
+web: bundle exec rackup config.ru -p $PORT

data/Rakefile

@@ -9,11 +9,18 @@ end
 
 if defined?(RSpec)
   desc "Run specs"
-  RSpec::Core::RakeTask.new(:spec)
+  RSpec::Core::RakeTask.new("spec") do |t|
+    t.pattern = "spec/core/**/*_spec.rb"
+  end
+
+  desc "Run server specs"
+  RSpec::Core::RakeTask.new("spec:server") do |t|
+    t.pattern = "spec/server/**/*_spec.rb"
+  end
 
   desc "Run live specs"
   RSpec::Core::RakeTask.new("spec:live") do |t|
-    t.pattern = "live/*_spec.rb"
+    t.pattern = "spec/live/**/*_spec.rb"
   end
 
   task :clean_live do
@@ -29,7 +36,7 @@ if defined?(RSpec)
   end
 
   desc 'Default: run specs.'
-  task :default => :spec
+  task :default => "spec"
 end
 
 # extracted from https://github.com/grosser/project_template

data/Readme.md

@@ -99,6 +99,26 @@ The methods under ZendeskAPI::Client (such as .tickets) return an instance of Ze
 Actual requests may not be sent until an explicit ZendeskAPI::Collection#fetch, ZendeskAPI::Collection#to_a, or an applicable methods such
 as #each.
 
+### Caveats
+
+Resource updating is implemented by sending only the `changed?` attributes to the server (see `ZendeskAPI::TrackChanges`).
+Unfortunately, this module only hooks into `Hash` meaning any changes to an `Array`not resulting in a new instance will not be tracked and sent.
+
+```
+zendesk_api_client_rb $ bundle console
+> a = ZendeskAPI::Trackie.new(:tags => []).tap(&:clear_changes)
+> a.changed?(:tags)
+ => false
+> a.tags << "my_new_tag"
+ => ["my_new_tag"]
+> a.changed?(:tags)
+ => false
+> a.tags += %w{my_other_tag}
+ => ["my_new_tag", "my_other_tag"]
+> a.changed?(:tags)
+ => true
+```
+
 ### Pagination
 
 ZendeskAPI::Collections can be paginated:
@@ -189,6 +209,15 @@ ticket.requester # => #<ZendeskAPI::User id=...>
 Currently, this feature is limited to only a few resources and their associations.
 They are documented on [developer.zendesk.com](http://developer.zendesk.com/documentation/rest_api/introduction.html#side-loading-\(beta\)).
 
+### Search
+
+Searching is done through the client. Returned is an instance of ZendeskAPI::Collection:
+
+```ruby
+client.search(:query => "my search query") # /api/v2/search.json?query=...
+client.users.search(:query => "my new query")  # /api/v2/users/search.json?query=...
+```
+
 ### Special case: Custom resources paths
 
 API endpoints such as tickets/recent or topics/show_many can be accessed through chaining.
@@ -230,6 +259,42 @@ ticket.comment.uploads << File.new("img.jpg")
 ticket.save
 ```
 
+## Extras
+
+The following projects are still works in progress and require checking out the repository,
+using ruby 1.9.3, and running `bundle install`.
+
+### Zendesk API Test Server
+
+Included in this repository is the code for the [Zendesk API Tester](https://zendesk-api.herokuapp.com/) website.
+
+```sh
+bin/zendesk server --help
+```
+
+Additional Dependencies:
+
+* sinatra
+* sinatra-contrib
+* haml
+* compass
+* coderay
+* coderay_bash
+* redcarpet
+* mongoid (and a working MongoDB instance)
+
+### Zendesk Console
+
+WIP
+
+```sh
+bin/zendesk console --help
+```
+
+Additional Dependencies:
+
+* ripl
+
 ## Note on Patches/Pull Requests
 1. Fork the project.
 2. Make your feature addition or bug fix.

data/bin/zendesk

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'bundler'
+
+ARGV[0] ||= "console"
+
+if %w(s server).include?(ARGV[0])
+  Bundler.setup(:default, :server)
+
+  require 'zendesk_api'
+  require 'zendesk_api/server/base'
+
+  OptionParser.new do |op|
+    op.banner = "Usage: zendesk s[erver] [options]"
+
+    op.on('-e env', 'Set the environment') {|val| ZendeskAPI::Server::App.set(:environment, val.to_sym)}
+    op.on('-p port', 'Bind to a port') {|val| ZendeskAPI::Server::App.set(:port, val.to_i)}
+    op.on('-o addr', 'Bind to a location') {|val| ZendeskAPI::Server::App.set(:bind, val)}
+  end.parse!(ARGV.dup)
+
+  ZendeskAPI::Server::App.run!
+else
+  Bundler.setup(:default, :console)
+
+  require 'zendesk_api'
+  require 'zendesk_api/console/base'
+end

data/config.ru

@@ -0,0 +1,6 @@
+require 'rack/ssl-enforcer'
+require 'zendesk_api'
+require 'zendesk_api/server/base'
+
+use Rack::SslEnforcer if ZendeskAPI::Server::App.production?
+run ZendeskAPI::Server::App

data/config/mongoid.yml

@@ -0,0 +1,81 @@
+development: &defaults
+  # Configure available database sessions. (required)
+  sessions:
+    # Defines the default session. (required)
+    default: &default_session
+      # Defines the name of the default database that Mongoid can connect to.
+      # (required).
+      database: zendesk_api_development
+      # Provides the hosts the default session can connect to. Must be an array
+      # of host:port pairs. (required)
+      hosts:
+        - localhost:27017
+      options:
+        # Change whether the session persists in safe mode by default.
+        # (default: false)
+        # safe: false
+
+        # Change the default consistency model to :eventual or :strong.
+        # :eventual will send reads to secondaries, :strong sends everything
+        # to master. (default: :eventual)
+        # consistency: :strong
+  # Configure Mongoid specific options. (optional)
+  options:
+    # Configuration for whether or not to allow access to fields that do
+    # not have a field definition on the model. (default: true)
+    # allow_dynamic_fields: true
+
+    # Enable the identity map, needed for eager loading. (default: false)
+    # identity_map_enabled: false
+
+    # Includes the root model name in json serialization. (default: false)
+    # include_root_in_json: false
+
+    # Include the _type field in serializaion. (default: false)
+    # include_type_for_serialization: false
+
+    # Preload all models in development, needed when models use
+    # inheritance. (default: false)
+    preload_models: true
+
+    # Protect id and type from mass assignment. (default: true)
+    # protect_sensitive_fields: true
+
+    # Raise an error when performing a #find and the document is not found.
+    # (default: true)
+    raise_not_found_error: false
+
+    # Raise an error when defining a scope with the same name as an
+    # existing method. (default: false)
+    # scope_overwrite_exception: false
+
+    # Skip the database version check, used when connecting to a db without
+    # admin access. (default: false)
+    # skip_version_check: false
+
+    # User Active Support's time zone in conversions. (default: true)
+    # use_activesupport_time_zone: true
+
+    # Ensure all times are UTC in the app side. (default: false)
+    # use_utc: false
+
+test:
+  <<: *defaults
+  sessions:
+    default:
+      <<: *default_session
+      database: zendesk_api_test
+
+<% if ENV['MONGOLAB_URI'] %>
+  <% uri = URI.parse(ENV['MONGOLAB_URI']) %>
+production:
+  <<: *defaults
+  sessions:
+    default:
+      <<: *default_session
+      database: <%= uri.path.sub('/','') %>
+      username: <%= uri.user %>
+      password: <%= uri.password %>
+      hosts:
+        - <%= uri.host %>:<%= uri.port %>
+<% end %>

data/lib/zendesk_api/actions.rb

@@ -19,7 +19,7 @@ module ZendeskAPI
 
       save_associations
 
-      response = @client.connection.send(method, req_path) do |req|
+      @response = @client.connection.send(method, req_path) do |req|
         req.body = if self.class.unnested_params
           attributes.changes
         else
@@ -27,7 +27,7 @@ module ZendeskAPI
         end
       end
 
-      @attributes.replace @attributes.deep_merge(response.body[self.class.singular_resource_name] || {})
+      @attributes.replace @attributes.deep_merge(@response.body[self.class.singular_resource_name] || {})
       @attributes.clear_changes
       clear_associations
       true

data/lib/zendesk_api/collection.rb

@@ -84,7 +84,7 @@ module ZendeskAPI
     # @return [Number] The total number of resources server-side (disregarding pagination).
     def count
       fetch
-      @count
+      @count || -1
     end
 
     # Changes the per_page option. Returns self, so it can be chained. No execution.
@@ -103,6 +103,14 @@ module ZendeskAPI
       self
     end
 
+    def first_page?
+      !@options["page"] || @options["page"].to_i <= 1
+    end
+
+    def last_page?
+      !@options["page"] || @options["page"].to_i * @options["per_page"].to_i >= count
+    end
+
     # Saves all newly created resources stored in this collection.
     # @return [Collection] self
     def save
@@ -282,17 +290,20 @@ module ZendeskAPI
       end
     end
 
-    alias :orig_to_s :to_s
-
     # @private
     def to_s
       if @resources
         @resources.inspect
       else
-        orig_to_s
+        inspect = []
+        inspect << "options=#{@options.inspect}" if @options.any?
+        inspect << "path=#{path}"
+        "#{Inflection.singular(@resource)} collection [#{inspect.join(",")}]"
       end
     end
 
+    alias :to_str :to_s
+
     private
 
     def set_page_and_count(body)