zendesk_api 0.0.9 → 0.1.1

data/.gitignore

@@ -5,3 +5,4 @@ spec/fixtures/cassettes
 spec/fixtures/credentials.yml
 coverage
 .yardoc
+example.rb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zendesk_api (0.0.9)
+    zendesk_api (0.1.0)
       faraday (>= 0.8.0)
       faraday_middleware (>= 0.8.7)
       hashie
@@ -18,11 +18,11 @@ GEM
     diff-lcs (1.1.3)
     faraday (0.8.1)
       multipart-post (~> 1.1)
-    faraday_middleware (0.8.7)
+    faraday_middleware (0.8.8)
       faraday (>= 0.7.4, < 0.9)
     hashie (1.2.0)
     inflection (1.0.0)
-    json (1.7.3)
+    json (1.7.4)
     mime-types (1.19)
     multi_json (1.3.6)
     multipart-post (1.1.5)
@@ -39,9 +39,9 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
-    vcr (2.2.2)
-    webmock (1.8.7)
-      addressable (>= 2.2.7)
+    vcr (2.2.4)
+    webmock (1.8.8)
+      addressable (~> 2.2.8)
       crack (>= 0.1.7)
     yard (0.8.2.1)
 
@@ -51,7 +51,7 @@ PLATFORMS
 DEPENDENCIES
   jruby-openssl
   rake
-  rspec (>= 2.0.0)
+  rspec (~> 2.10.0)
   simplecov
   vcr
   webmock

data/Readme.md

@@ -10,31 +10,37 @@ Version 0.0.5 brings with it a change to the top-level namespace. All references
 
 ## Installation
 
-Currently
+The Zendesk API client can be installed using Rubygems or Bundler.
 
-    gem install zendesk_api
+### Rubygems
 
-will not install this version of the API client. To install this client, either clone this repository and run
+```sh
+gem install zendesk_api
+```
+
+### Bundler
 
-    rake install
+Add it to your Gemfile
 
-or add it to a Gemfile like so:
+    gem "zendesk_api"
 
-    gem "zendesk_api", :git => "git://github.com/zendesk/zendesk_api_client_rb.git" #, :tag => "vX.X.X"
+and follow normal [Bundler](http://gembundler.com/) installation and execution procedures.
 
 ## Configuration
 
 Configuration is done through a block returning an instance of ZendeskAPI::Client.
 The block is mandatory and if not passed, an ArgumentError will be thrown.
 
-```
-ZendeskAPI::Client.new do |config|
+```ruby
+require 'zendesk_api'
+
+client = ZendeskAPI::Client.new do |config|
   # Mandatory:
 
-  config.url = "https://mydesk.zendesk.com/api/v2"
+  config.url = "<- your-zendesk-url ->" # e.g. https://mydesk.zendesk.com/api/v2
 
-  config.username = "test.user"
-  config.password = "test.password"
+  config.username = "login.email@zendesk.com"
+  config.password = "your zendesk password or token"
 
   # Optional:
 
@@ -48,12 +54,12 @@ ZendeskAPI::Client.new do |config|
   config.logger = Logger.new(STDOUT)
 
   # Changes Faraday adapter
-  config.adapter = :patron
+  # config.adapter = :patron
 
   # Merged with the default client options hash
-  config.client_options = { :ssl => false }
+  # config.client_options = { :ssl => false }
 
-  # When getting the error 'hostname does not match the server certificate' 
+  # When getting the error 'hostname does not match the server certificate'
   # use the API at https://yoursubdomain.zendesk.com/api/v2
 end
 ```
@@ -66,19 +72,19 @@ The result of configuration is an instance of ZendeskAPI::Client which can then
 
 One way to use the client is to pass it in as an argument to individual classes.
 
-```
+```ruby
 ZendeskAPI::Ticket.new(client, :id => 1, :priority => "urgent") # doesn't actually send a request, must explicitly call #save
-ZendeskAPI::Ticket.create(client, :subject => "Test Ticket", :description => "This is a test", :submitter_id => client.current_user.id, :priority => "urgent")
+ZendeskAPI::Ticket.create(client, :subject => "Test Ticket", :comment => { :value => "This is a test" }, :submitter_id => client.current_user.id, :priority => "urgent")
 ZendeskAPI::Ticket.find(client, :id => 1)
 ZendeskAPI::Ticket.delete(client, :id => 1)
 ```
 
 Another way is to use the instance methods under client.
 
-```
+```ruby
 client.tickets.first
 client.tickets.find(:id => 1)
-client.tickets.create(:subject => "Test Ticket", :description => "This is a test", :submitter_id => client.current_user.id, :priority => "urgent")
+client.tickets.create(:subject => "Test Ticket", :comment => { :value => "This is a test" }, :submitter_id => client.current_user.id, :priority => "urgent")
 client.tickets.delete(:id => 1)
 ```
 
@@ -90,7 +96,7 @@ as #each.
 
 ZendeskAPI::Collections can be paginated:
 
-```
+```ruby
 tickets = client.tickets.page(2).per_page(3)
 next_page = tickets.next
 previous_page = tickets.prev
@@ -100,7 +106,7 @@ previous_page = tickets.prev
 
 Callbacks can be added to the ZendeskAPI::Client instance and will be called (with the response env) after all response middleware on a successful request.
 
-```
+```ruby
 client.insert_callback do |env|
   puts env[:response_headers]
 end
@@ -110,7 +116,7 @@ end
 
 Individual resources can be created, modified, saved, and destroyed.
 
-```
+```ruby
 ticket = client.tickets[0] # ZendeskAPI::Ticket.find(client, :id => 1)
 ticket.priority = "urgent"
 ticket.attributes # => { "priority" => "urgent" }
@@ -127,7 +133,7 @@ ticket.save # Will POST
 API endpoints such as tickets/recent or topics/show_many can be accessed through chaining.
 They will too return an instance of ZendeskAPI::Collection.
 
-```
+```ruby
 client.tickets.recent
 client.topics.show_many(:verb => :post, :ids => [1, 2, 3])
 ```
@@ -136,20 +142,20 @@ client.topics.show_many(:verb => :post, :ids => [1, 2, 3])
 
 Use either of the following to obtain the current user instance:
 
-```
+```ruby
 client.users.find(:id => 'me')
 client.current_user
 ```
 
 ### Attaching files
 
-Files can be attached to tickets using either a path or the File class and will
+Files can be attached to ticket comments using either a path or the File class and will
 be automatically uploaded and attached.
 
-```
-ticket = Ticket.new(...)
-ticket.uploads << "img.jpg"
-ticket.uploads << File.new("img.jpg")
+```ruby
+ticket = ZendeskAPI::Ticket.new(client, :comment => { :value => "attachments" })
+ticket.comment.uploads << "img.jpg"
+ticket.comment.uploads << File.new("img.jpg")
 ticket.save
 ```
 

data/lib/zendesk_api/association.rb

@@ -239,9 +239,9 @@ module ZendeskAPI
   end
 
   class << self
-    # Revert Rails' overwrite of const_missing
-    if method_defined?(:const_missing_without_dependencies)
-      alias :const_missing :const_missing_without_dependencies
+    # Make sure Rails' overwriting of const_missing doesn't cause trouble
+    def const_missing(*args)
+      Object.const_missing(*args)
     end
 
     # Allows using has and has_many without having class defined yet

data/lib/zendesk_api/collection.rb

@@ -212,7 +212,11 @@ module ZendeskAPI
 
     # Sends methods to underlying array of resources.
     def method_missing(name, *args, &block)
-      if Array.new.respond_to?(name)
+      methods = @resource_class.singleton_methods(false).map(&:to_sym)
+
+      if methods.include?(name)
+        @resource_class.send(name, @client, *args, &block)
+      elsif Array.new.respond_to?(name)
         to_a.send(name, *args, &block)
       else
         opts = args.last.is_a?(Hash) ? args.last : {}

data/lib/zendesk_api/middleware/request/upload.rb

@@ -6,25 +6,64 @@ module ZendeskAPI
     module Request
       class Upload < Faraday::Middleware
         def call(env)
-          if env[:body] && env[:body][:file]
-            file = env[:body].delete(:file)
-            case file
-            when File
-              path = file.path
-            when String
-              path = file
-            else
-              warn "WARNING: Passed invalid filename #{file} of type #{file.class} to upload"
-            end
+          if env[:body]
+            set_file(env[:body], :file, true)
+            traverse_hash(env[:body])
+          end
+
+          @app.call(env)
+        end
+
+        private
+
+        # Sets the proper file parameters :uploaded_data and :filename
+        # If top_level, then it removes key and and sets the parameters directly on hash,
+        # otherwise it adds the parameters to hash[key]
+        def set_file(hash, key, top_level)
+          return unless hash.key?(key)
+
+          file = if hash[key].is_a?(Hash) && hash[key].key?(:file)
+            hash[key].delete(:file)
+          else
+            hash.delete(key)
+          end
 
-            if path
-              env[:body][:filename] ||= File.basename(path)
-              mime_type = MIME::Types.type_for(path).first || "application/octet-stream"
-              env[:body][:uploaded_data] = Faraday::UploadIO.new(path, mime_type)
+          case file
+          when File
+            path = file.path
+          when String
+            path = file
+          else
+            warn "WARNING: Passed invalid filename #{file} of type #{file.class} to upload"
+          end
+
+          if path
+            if !top_level
+              hash[key] ||= {}
+              hash = hash[key]
             end
+
+            mime_type = MIME::Types.type_for(path).first || "application/octet-stream"
+
+            hash[:filename] ||= File.basename(path)
+            hash[:uploaded_data] = Faraday::UploadIO.new(path, mime_type)
           end
+        end
 
-          @app.call(env)
+        # Calls #set_file on File instances or Hashes
+        # of the format { :file => File (, :filename => ...) }
+        def traverse_hash(hash)
+          hash.keys.each do |key|
+            if hash[key].is_a?(File)
+              set_file(hash, key, false)
+            elsif hash[key].is_a?(Hash)
+              if hash[key].key?(:file)
+                set_file(hash, key, false)
+              else
+                traverse_hash(hash[key])
+              end
+            end
+          end
         end
       end
     end

data/lib/zendesk_api/resource.rb

@@ -125,7 +125,7 @@ module ZendeskAPI
     extend Read
     include Create
 
-    include Update 
+    include Update
     include Destroy
   end
 

data/lib/zendesk_api/resources/misc.rb

@@ -23,7 +23,7 @@ module ZendeskAPI
     has :ticket
     has :group
   end
-  
+
   class Attachment < Data
     def initialize(client, attributes)
       if attributes.is_a?(Hash)
@@ -34,7 +34,7 @@ module ZendeskAPI
     end
 
     def save
-      upload = Upload.create!(client, :file => file)
+      upload = Upload.create!(@client, :file => file)
       self.token = upload.token
     end
 

data/lib/zendesk_api/resources/ticket.rb

@@ -1,6 +1,19 @@
 module ZendeskAPI
   class TicketField < Resource; end
-  class TicketComment < Data; end
+
+  class TicketComment < Data
+    include Save
+
+    has_many :uploads, :class => :attachment, :inline => true
+
+    def save
+      save_associations
+      true
+    end
+
+    alias :save! :save
+  end
+
   class TicketMetric < ReadResource; end
 
   class Ticket < Resource
@@ -17,7 +30,6 @@ module ZendeskAPI
     has :forum_topic, :class => :topic
     has :organization
 
-    has_many :uploads, :class => :attachment, :inline => true
     has :comment, :class => :ticket_comment, :inline => true
 
     # Gets a incremental export of tickets from the start_time until now.
@@ -71,6 +83,4 @@ module ZendeskAPI
       Zendesk::Collection.new(client, ViewRow, options.merge(:path => "views/preview"))
     end
   end
-
-
 end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "0.0.9"
+  VERSION = "0.1.1"
 end

data/live/ticket_spec.rb

@@ -5,7 +5,7 @@ describe ZendeskAPI::Ticket do
     { 
       :type => "question",
       :subject => "This is a question?",
-      :description => "Indeed it is!",
+      :comment => { :value => "Indeed it is!" },
       :priority => "normal",
       :requester_id => user.id,
       :submitter_id => user.id
@@ -66,12 +66,12 @@ describe ZendeskAPI::Ticket do
   it "can upload while creating" do
     VCR.use_cassette("ticket_inline_uploads") do
       ticket = ZendeskAPI::Ticket.new(client, valid_attributes.merge(default_options))
-      ticket.uploads << "spec/fixtures/Argentina.gif"
-      #ticket.uploads << File.new("spec/fixtures/Argentina.gif") # TODO ZendeskAPI bug: you can only upload 1 picture at a time
+      ticket.comment.uploads << "spec/fixtures/Argentina.gif"
+      ticket.comment.uploads << File.new("spec/fixtures/Argentina.gif")
 
       ticket.save!
-      ticket.changes.should == {} # uploads where set before save
-      ticket.attributes[:uploads].map(&:class).should == [String] # upload was sent as tokens
+      ticket.changes.should == {} # uploads were set before save
+      ticket.comment.attributes[:uploads].map(&:class).should == [String, String] # upload was sent as tokens
     end
   end
 

data/live/user_spec.rb

@@ -10,4 +10,10 @@ describe ZendeskAPI::User, :delete_after do
   it_should_be_deletable :find => [:active?, false]
   it_should_be_readable :users
   it_should_be_readable organization, :users
+
+  it "should be able to find by email" do
+    VCR.use_cassette("user_find_by_email") do
+      client.users.search(:query => current_user.email).to_a.should == [current_user]
+    end
+  end
 end

data/spec/collection_spec.rb

@@ -266,6 +266,12 @@ describe ZendeskAPI::Collection do
   context "method missing" do
     before(:each) { subject.stub(:fetch).and_return([1, 2, nil, 3]) }
 
+    context "with an class method on the resource class" do
+      it "should pass methods to class if defined" do
+        subject.test.should == "hi"
+      end
+    end
+
     it "should pass all methods not defined to resources" do
       subject.compact.should == [1, 2, 3]
     end

data/spec/fixtures/test_resources.rb

@@ -1,4 +1,8 @@
 class ZendeskAPI::TestResource < ZendeskAPI::Resource
+  def self.test(client)
+    "hi"
+  end
+
   class TestChild < ZendeskAPI::Resource
   end
 end

data/spec/middleware/request/upload_spec.rb

@@ -45,29 +45,61 @@ describe ZendeskAPI::Middleware::Request::Upload do
   end
 
   context "with file instance" do
-    before(:each) do
-      @env = subject.call(:body => { :file => File.new(filename) })
-    end
+    context "top-level" do
+      before(:each) do
+        @env = subject.call(:body => { :file => File.new(filename) })
+      end
 
-    it "should convert file string to UploadIO" do
-      @env[:body][:uploaded_data].should be_instance_of(Faraday::UploadIO)
-    end
+      it "should convert file string to UploadIO" do
+        @env[:body][:uploaded_data].should be_instance_of(Faraday::UploadIO)
+      end
 
-    it "should remove file string" do
-      @env[:body][:file].should be_nil
-    end
+      it "should remove file string" do
+        @env[:body][:file].should be_nil
+      end
 
-    it "should add filename if none exist" do
-      @env[:body][:filename].should == "test.jpg"
+      it "should add filename if none exist" do
+        @env[:body][:filename].should == "test.jpg"
+      end
+
+      context "with filename" do
+        before(:each) do
+          @env = subject.call(:body => { :file => File.new(filename), :filename => "test" })
+        end
+
+        it "should not change filename" do
+          @env[:body][:filename].should_not == "test.jpg"
+        end
+      end
     end
 
-    context "with filename" do
-      before(:each) do
-        @env = subject.call(:body => { :file => File.new(filename), :filename => "test" })
+    context "underneath a key" do
+      context "only a file" do
+        before(:each) do
+          @env = subject.call(:body => { :user => { :photo => File.new(filename) } })
+        end
+
+        it "should convert file string to UploadIO" do
+          @env[:body][:user][:photo][:uploaded_data].should be_instance_of(Faraday::UploadIO)
+        end
+
+        it "should add filename if none exist" do
+          @env[:body][:user][:photo][:filename].should == "test.jpg"
+        end
       end
 
-      it "should not change filename" do
-        @env[:body][:filename].should_not == "test.jpg"
+      context "with filename" do
+        before(:each) do
+          @env = subject.call(:body => { :user => { :photo => { :file => File.new(filename), :filename => "test" } } })
+        end
+
+        it "should convert file string to UploadIO" do
+          @env[:body][:user][:photo][:uploaded_data].should be_instance_of(Faraday::UploadIO)
+        end
+
+        it "should not change filename" do
+          @env[:body][:user][:photo][:filename].should_not == "test.jpg"
+        end
       end
     end
   end

data/zendesk_api.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version     = ">= 1.8.7"
   s.required_rubygems_version = ">= 1.3.6"
 
-  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "rspec", "~> 2.10.0"
   s.add_development_dependency "vcr"
   s.add_development_dependency "webmock"
   s.add_development_dependency "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-29 00:00:00.000000000 Z
+date: 2012-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement