zendesk2 0.0.4 → 0.0.5

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+bundler_args: "--without development"
+before_install:
+  - gem install bundler --pre
+script: "bundle exec rake --trace"

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in zendesk2.gemspec
 gemspec
 
+gem 'rake'
+
 group :test do
   gem 'guard-rspec'
   gem 'rspec'

data/README.md

@@ -1,6 +1,8 @@
 # Zendesk2
 
-TODO: Write a gem description
+[![Build Status](https://secure.travis-ci.org/lanej/zendesk2.png)](http://travis-ci.org/lanej/zendesk2)
+
+Ruby client for the [Zendesk V2 API](http://developer.zendesk.com/documentation/rest_api/introduction.html) using [cistern](https://github.com/lanej/cistern) and [faraday](https://github.com/technoweenie/faraday)
 
 ## Installation
 
@@ -8,17 +10,142 @@ Add this line to your application's Gemfile:
 
     gem 'zendesk2'
 
-And then execute:
-
-    $ bundle
-
 Or install it yourself as:
 
     $ gem install zendesk2
 
 ## Usage
 
-TODO: Write usage instructions here
+### Defaults
+
+Default credentials will be read in from `~/.zendesk2` file in YAML format.
+
+	---
+	:subdomain: zendeskdev
+	:username: zendeskedge@example.com
+	:password: wickedsecurepassword
+
+### Creating the client
+
+Either the absolute url or the subdomain is required.  Username and password is always required.
+
+	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
+
+	=> #<Zendesk2::Client::Real:0x007fd1bae486b0 @url="http://support.cloud.engineyard.com", @username="mate", @password="bambilla", …>
+
+### Resources
+
+#### Collections
+
+Currently support resources
+
+* User
+* Ticket
+* Organization
+
+All collection are accessed like so:
+
+    client.users.all
+     =>   <Zendesk2::Client::Users
+    count=1779,
+    next_page_link="https://dev.zendesk.com/api/v2/users.json?page=2",
+    previous_page_link=nil
+    [
+      <Zendesk2::Client::User
+        id=125394183,
+        url="https://dev.zendesk.com/api/v2/users/125394183.json",
+        ...
+       >
+    ]
+
+Collections also respond to `create` and `new`
+
+	client.users.create(email: "ohhai@example.org", name: "lulz")
+	 =>   <Zendesk2::Client::User
+    id=234020811,
+    ...
+    url="https://engineyarddev.zendesk.com/api/v2/users/234020811.json",
+    ...
+    email="ohhai@example.org",
+    >
+
+
+	client.users.new(email: "ohhai@example.org")
+	=>    <Zendesk2::Client::User
+    id=nil,
+    ...
+    url=nil,
+    ...
+    email="ohhai@example.org",
+    ...
+    >
+
+#### Paging
+
+Paged collections respond to `next_page` and `previous_page` when appropriate.  `page_size` and `page` can be passed directly to the collection to control size and index.
+
+    page = client.users.all("per_page" => 1, "page" => 4)
+	 =>   <Zendesk2::Client::Users
+    count=1780,
+    next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1",
+    previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1"
+    [
+      <Zendesk2::Client::User
+        id=217761652,
+        url="https://dev.zendesk.com/api/v2/users/217761652.json",
+        external_id=nil,
+        name="Guy Dude",
+        ...
+       >
+    ]
+
+    page.next_page
+	 =>   <Zendesk2::Client::Users
+    count=1780,
+    next_page_link="https://dev.zendesk.com/api/v2/users.json?page=6&per_page=1",
+    previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=4&per_page=1"
+    [
+      <Zendesk2::Client::User
+        id=217761742,
+        url="https://dev.zendesk.com/api/v2/users/217761742.json",
+        ...
+        name="epitaphical osteofibrous",
+        ...
+        >
+     ]
+
+    page.previous_page
+	 =>   <Zendesk2::Client::Users
+    count=1780,
+    next_page_link="https://dev.zendesk.com/api/v2/users.json?page=5&per_page=1",
+    previous_page_link="https://dev.zendesk.com/api/v2/users.json?page=3&per_page=1"
+    [
+      <Zendesk2::Client::User
+        id=217761652,
+        url="https://dev.zendesk.com/api/v2/users/217761652.json",
+        ...
+        name="Guy Dude",
+        ...
+      >
+    ]
+
+#### Models
+
+All models respond to `destroy` and `save` if applicable.  `save` performs a 'create' operation if there is no identity provided or an 'update' if there is an identity.
+
+	Zendesk2::Client::Ticket.new.save        # performs a create
+	Zendesk2::Client::Ticket.new(id: 1).save # performs an update
+
+Attributes can be enumerated by the `attributes` method.
+
+## Releasing
+
+
+  	$ gem install gem-release
+  	$ gem bump -trv (major|minor|patch)
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,7 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/zendesk2/client.rb

@@ -29,7 +29,7 @@ class Zendesk2::Client < Cistern::Service
   request :update_ticket
   request :update_user
 
-  recognizes :url, :subdomain, :host, :port, :path, :scheme, :logger, :adapter
+  recognizes :url, :subdomain, :host, :port, :path, :scheme, :logger, :adapter, :username, :password, :token
 
   class Real
 
@@ -42,28 +42,28 @@ class Zendesk2::Client < Cistern::Service
 
         host ||= "#{subdomain}.zendesk.com"
 
-        @path   = options[:path] || "api/v2"
+        path   = options[:path] || "api/v2"
         scheme = options[:scheme] || "https"
 
         port   = options[:port] || (scheme == "https" ? 443 : 80)
 
-        "#{scheme}://#{host}:#{port}/#{@path}"
+        "#{scheme}://#{host}:#{port}/#{path}"
       end
 
-      @url  = url
-      @path ||= URI.parse(url).path
+      @url  = URI.parse(url).to_s
 
       logger             = options[:logger]
       adapter            = options[:adapter] || :net_http
       connection_options = options[:connection_options] || {ssl: {verify: false}}
-      @username          = options[:username] || Zendesk2.defaults[:username]
-      @password          = options[:password] || Zendesk2.defaults[:password]
+      username           = options[:username] || Zendesk2.defaults[:username]
+      password           = options[:password] || Zendesk2.defaults[:password]
+      @token             = options[:token]
 
-      raise "Missing required options: [:username, :password]" unless @username && @password
+      raise "Missing required options: [:username, :password]" unless username && password
 
       @connection = Faraday.new({url: @url}.merge(connection_options)) do |builder|
         # response
-        builder.use Faraday::Request::BasicAuthentication, @username, @password
+        builder.use Faraday::Request::BasicAuthentication, username, password
         builder.use Faraday::Response::RaiseError
         builder.use Faraday::Response::Logger, logger if logger
         builder.response :json
@@ -163,13 +163,9 @@ class Zendesk2::Client < Cistern::Service
 
       next_page = if page_index < total_pages
                     url_for("#{path}?page=#{page_index + 1}&per_page=#{page_size}")
-                  else
-                    nil
                   end
       previous_page = if page_index > 1
                         url_for("#{path}?page=#{page_index - 1}&per_page=#{page_size}")
-                      else
-                        nil
                       end
 
       resource_page = resources.slice(offset, page_size)
@@ -201,7 +197,7 @@ class Zendesk2::Client < Cistern::Service
         :url             => url,
         :body            => body,
         :request_headers => {
-          "Content-Type"   => "application/json"
+          "Content-Type"   => "application/json; charset=utf-8"
         },
       )
     end

data/lib/zendesk2/models/organization.rb

@@ -1,17 +1,17 @@
 class Zendesk2::Client::Organization < Cistern::Model
   include Zendesk2::Errors
-  identity :id
-  attribute :shared_comments
-  attribute :notes
+  identity :id,               type: :integer
+  attribute :shared_comments, type: :boolean
+  attribute :notes,           type: :array
   attribute :tags
-  attribute :domain_names
-  attribute :group_id
-  attribute :external_id
+  attribute :domain_names,    type: :array
+  attribute :group_id,        type: :integer
+  attribute :external_id,     type: :integer
   attribute :name
-  attribute :created_at, type: :time
+  attribute :created_at,      type: :time
   attribute :details
-  attribute :shared_tickets
-  attribute :updated_at, type: :time
+  attribute :shared_tickets,  type: :boolean
+  attribute :updated_at,      type: :time
 
   def destroy
     requires :identity

data/lib/zendesk2/models/ticket.rb

@@ -1,28 +1,28 @@
 class Zendesk2::Client::Ticket < Cistern::Model
   include Zendesk2::Errors
-  identity :id
+  identity :id,                type: :id
   attribute :external_id
   attribute :via
-  attribute :created_at, type: :time
-  attribute :updated_at, type: :time
+  attribute :created_at,       type: :time
+  attribute :updated_at,       type: :time
   attribute :type
   attribute :subject
   attribute :description
   attribute :priority
   attribute :status
   attribute :recipient
-  attribute :requester_id
-  attribute :submitter_id
-  attribute :assignee_id
-  attribute :organization_id
-  attribute :group_id
+  attribute :requester_id,     type: :integer
+  attribute :submitter_id,     type: :integer
+  attribute :assignee_id,      type: :integer
+  attribute :organization_id,  type: :integer
+  attribute :group_id,         type: :integer
   attribute :collaborator_ids, type: :array
-  attribute :forum_topic_id
-  attribute :problem_id
-  attribute :has_incidents
-  attribute :due_at, type: :time
-  attribute :tags, type: :array
-  attribute :fields
+  attribute :forum_topic_id,   type: :integer
+  attribute :problem_id,       type: :integer
+  attribute :has_incidents,    type: :boolean
+  attribute :due_at,           type: :time
+  attribute :tags,             type: :array
+  attribute :fields,           type: :array
 
   def save
     if new_record?

data/lib/zendesk2/models/user.rb

@@ -1,31 +1,31 @@
 class Zendesk2::Client::User < Cistern::Model
-  identity :id
+  identity :id,                     type: :id
   attribute :url
   attribute :external_id
   attribute :name
   attribute :alias
-  attribute :created_at, type: :time
-  attribute :updated_at, type: :time
-  attribute :active, type: :boolean
-  attribute :verified, type: :boolean
-  attribute :shared
-  attribute :locale_id
+  attribute :created_at,            type: :time
+  attribute :updated_at,            type: :time
+  attribute :active,                type: :boolean
+  attribute :verified,              type: :boolean
+  attribute :shared,                type: :boolean
+  attribute :locale_id,             type: :integer
   attribute :locale
   attribute :time_zone
-  attribute :last_login_at, type: :time
+  attribute :last_login_at,         type: :time
   attribute :email
   attribute :phone
   attribute :signature
   attribute :details
   attribute :notes
-  attribute :organization_id
+  attribute :organization_id,       type: :integer
   attribute :role
-  attribute :custom_role_id
-  attribute :moderator
+  attribute :custom_role_id,        type: :integer
+  attribute :moderator,             type: :boolean
   attribute :ticket_restriction
-  attribute :only_private_comments
-  attribute :tags
-  attribute :suspended
+  attribute :only_private_comments, type: :boolean
+  attribute :tags,                  type: :array
+  attribute :suspended,             type: :boolean
   attribute :photo
   attribute :authenticity_token
 
@@ -53,9 +53,46 @@ class Zendesk2::Client::User < Cistern::Model
     !self.active
   end
 
+  def organization=(organization)
+    self.organization_id= organization.id
+  end
+
+  def organization
+    self.connection.organizations.get(self.organization_id)
+  end
+
+  def login_url(timestamp, options={})
+    requires :name, :email
+
+    return_to = options[:return_to]
+    token     = self.token || options[:token]
+
+    uri      = Addressable::URI.parse(self.connection.url)
+    uri.path = "/access/remote"
+
+    raise "timestamp cannot be nil" unless timestamp
+
+    hash_str = "#{self.name}#{self.email}#{token}#{timestamp}"
+    query_values = {
+      'name'      => name,
+      'email'     => email,
+      'timestamp' => timestamp,
+      'hash'      => Digest::MD5.hexdigest(hash_str)
+    }
+    unless Zendesk2.blank?(return_to)
+      query_values['return_to'] = return_to
+    end
+    uri.query_values = query_values
+
+    uri.to_s
+  end
+
   private
 
   def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), "name", "email", "organization_id", "external_id", "alias", "active", "verified", "locate_id", "time_zone", "phone", "signature", "details", "notes", "role", "custom_role_id", "moderator", "ticket_restriction", "only_private_comments")
+    writable_attributes = Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), "name", "email", "organization_id", "external_id", "alias", "verified", "locate_id", "time_zone", "phone", "signature", "details", "notes", "role", "custom_role_id", "moderator", "ticket_restriction", "only_private_comments")
+    writable_attributes.delete("organization_id") if writable_attributes["organization_id"] == 0
+    writable_attributes.delete("custom_role_id") if writable_attributes["custom_role_id"] == 0
+    writable_attributes
   end
 end

data/lib/zendesk2/paged_collection.rb

@@ -14,12 +14,13 @@ module Zendesk2::PagedCollection
   def all(params={})
     body = connection.send(collection_method, params).body
 
-    load(body[collection_root])
-    merge_attributes(Cistern::Hash.slice(body, "count", "next_page", "previous_page"))
+    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 = connection.send(model_method, {"id" => id}).body[self.model_root]
+    if data = self.connection.send(model_method, {"id" => id}).body[self.model_root]
       new(data)
     end
   end

data/lib/zendesk2/requests/get_organization_tickets.rb

@@ -16,8 +16,8 @@ class Zendesk2::Client
     def get_organization_tickets(params={})
       id = params["id"]
 
-      requesters = self.data[:users].values.select{|u| u["organization_id"].to_s == id.to_s}.map{|s| s["organization_id"].to_s}
-      page(params, :tickets, "/organizations/#{id}/tickets.json", "tickets", filter: lambda{|c| c.select{|u| requesters.include?(u["organization_id"].to_s)}})
+      requesters = self.data[:users].values.select{|u| u["organization_id"] == id}.map{|s| s["organization_id"]}
+      page(params, :tickets, "/organizations/#{id}/tickets.json", "tickets", filter: lambda{|c| c.select{|u| requesters.include?(u["organization_id"])}})
     end
   end # Mock
 end

data/lib/zendesk2/requests/get_organization_users.rb

@@ -15,7 +15,7 @@ class Zendesk2::Client
   class Mock
     def get_organization_users(params={})
       id = params["id"]
-      page(params, :users, "/organizations/#{id}/users.json", "users", filter: lambda{|c| c.select{|u| u["organization_id"].to_s == id.to_s}})
+      page(params, :users, "/organizations/#{id}/users.json", "users", filter: lambda{|c| c.select{|u| u["organization_id"] == id}})
     end
   end # Mock
 end

data/lib/zendesk2/requests/update_user.rb

@@ -10,6 +10,8 @@ class Zendesk2::Client
           "user" => params
         },
       )
+    rescue => e
+      p e.response
     end
   end
   class Mock

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/zendesk2.rb

@@ -37,6 +37,8 @@ module Zendesk2
   def self.stringify_keys(hash)
     hash.inject({}){|r,(k,v)| r.merge(k.to_s => v)}
   end
-end
 
-Zendesk = Zendesk2
+  def self.blank?(string)
+    !!string || string == ""
+  end
+end

data/spec/shared/resource.rb

@@ -17,14 +17,14 @@ shared_examples "a resource" do |_collection, _params, _update_params|
     end
 
     it "by retrieving the next page" do
-      first_page = collection.all("per_page" => "1").to_a
-      second_page = collection.all("per_page" => 1).next_page.to_a
+      first_page = collection.all("per_page" => 1)
+      second_page = collection.all("per_page" => 1).next_page
       second_page.should_not == first_page
     end
 
     it "by retrieving the previous page" do
-      first_page = collection.all("per_page" => "1").to_a
-      previous_to_second_page = collection.all("per_page" => 1).next_page.previous_page.to_a
+      first_page = collection.all("per_page" => "1")
+      previous_to_second_page = collection.all("per_page" => 1).next_page.previous_page
       previous_to_second_page.should == first_page
     end
   end

data/spec/users_spec.rb

@@ -4,8 +4,8 @@ describe "users" do
   let(:client) { create_client }
   it_should_behave_like "a resource", 
     :users,
-    lambda { {email: "zendesk2+#{Zendesk2.uuid}@example.org", name: "Roger Wilco", verified: true} },
-    lambda { {name: "Rogerito Wilcinzo"} }
+    lambda { {email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid, verified: true} },
+    lambda { {name: Zendesk2.uuid} }
 
   it "should get current user" do
     current_user = client.users.current

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-19 00:00:00.000000000 Z
+date: 2012-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cistern
@@ -100,6 +100,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE
@@ -172,4 +173,3 @@ test_files:
 - spec/support/client_helper.rb
 - spec/tickets_spec.rb
 - spec/users_spec.rb
-has_rdoc: