zendesk_api 0.1.7 → 0.1.8

data/util/verb_handler.rb

@@ -0,0 +1,16 @@
+class VerbHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:put), method_call(:post), method_call(:get)
+
+  def process
+    name = statement.parameters.first.jump(:ident).source
+
+    verb = YARD::CodeObjects::MethodObject.new(namespace, name)
+    register(verb)
+    verb.dynamic = true
+    verb.docstring.add_tag(YARD::Tags::Tag.new(:return, "Success of this call", "Boolean"))
+
+    verb.signature = "def #{name}=(options = {})"
+    verb.parameters = [['options', {}]]
+    verb.docstring.add_tag(YARD::Tags::Tag.new(:param, "Options to pass to the request", "Hash", "options"))
+  end
+end

data/zendesk_api.gemspec

@@ -18,10 +18,11 @@ Gem::Specification.new do |s|
   s.required_ruby_version     = ">= 1.8.7"
   s.required_rubygems_version = ">= 1.3.6"
 
+  s.add_development_dependency "bump"
+  s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "vcr"
   s.add_development_dependency "webmock"
-  s.add_development_dependency "rake"
   s.add_development_dependency "yard"
 
 # Optional. Only used for uploads testing.
@@ -30,8 +31,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "faraday", ">= 0.8.0"
   s.add_runtime_dependency "faraday_middleware", ">= 0.8.7"
   s.add_runtime_dependency "hashie"
-  s.add_runtime_dependency "json"
   s.add_runtime_dependency "inflection"
+  s.add_runtime_dependency "json"
   s.add_runtime_dependency "mime-types"
   s.add_runtime_dependency "multipart-post"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -10,10 +10,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-24 00:00:00.000000000 Z
+date: 2012-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -29,7 +29,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -45,7 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -61,7 +61,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -141,7 +157,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: inflection
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -157,7 +173,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: inflection
+  name: json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -240,10 +256,7 @@ files:
 - lib/zendesk_api/middleware/response/parse_iso_dates.rb
 - lib/zendesk_api/rescue.rb
 - lib/zendesk_api/resource.rb
-- lib/zendesk_api/resources/forum.rb
-- lib/zendesk_api/resources/misc.rb
-- lib/zendesk_api/resources/ticket.rb
-- lib/zendesk_api/resources/user.rb
+- lib/zendesk_api/resources.rb
 - lib/zendesk_api/sideloading.rb
 - lib/zendesk_api/track_changes.rb
 - lib/zendesk_api/trackie.rb
@@ -308,6 +321,8 @@ files:
 - spec/search_spec.rb
 - spec/spec_helper.rb
 - spec/trackie_spec.rb
+- util/resource_handler.rb
+- util/verb_handler.rb
 - zendesk_api.gemspec
 homepage: http://developer.zendesk.com
 licenses:

data/lib/zendesk_api/resources/forum.rb

@@ -1,51 +0,0 @@
-module ZendeskAPI
-  class ForumSubscription < Resource
-    only_send_unnested_params
-    has :forum
-    has :user
-  end
-
-  class Forum < Resource
-    has :category
-    has :organization
-    has :locale
-
-    has_many :topics
-    has_many :subscriptions, :class => :forum_subscription
-  end
-
-  class Category < Resource
-    has_many :forums
-  end
-
-  class TopicSubscription < Resource
-    only_send_unnested_params
-    has :topic
-    has :user
-  end
-
-  class Topic < Resource
-    class TopicComment < Resource
-      has :topic
-      has :user
-      has_many :attachments
-    end
-
-    class TopicVote < SingularResource
-      only_send_unnested_params
-      has :topic
-      has :user
-    end
-
-    has_many :comments, :class => :topic_comment
-    has_many :subscriptions, :class => :topic_subscription
-    has :vote, :class => :topic_vote
-
-    def votes(opts = {})
-      return @votes if @votes && !opts[:reload]
-
-      association = ZendeskAPI::Association.new(:class => Topic::TopicVote, :parent => self, :path => 'votes')
-      @votes = ZendeskAPI::Collection.new(@client, Topic::TopicVote, opts.merge(:association => association))
-    end
-  end
-end

data/lib/zendesk_api/resources/misc.rb

@@ -1,79 +0,0 @@
-module ZendeskAPI
-  class Activity < Resource
-    has :user
-    has :actor, :class => :user
-  end
-
-  class Setting < DataResource
-    attr_reader :on
-
-    def initialize(client, attributes = {})
-      @on = attributes.first
-      super(client, attributes[1])
-    end
-  end
-
-  class MobileDevice < Resource
-    put :clear_badge
-  end
-
-  class SatisfactionRating < ReadResource
-    has :assignee, :class => :user 
-    has :requester, :class => :user
-    has :ticket
-    has :group
-  end
-
-  class Attachment < Data
-    def initialize(client, attributes)
-      if attributes.is_a?(Hash)
-        super
-      else
-        super(client, :file => attributes)
-      end
-    end
-
-    def save
-      upload = Upload.create!(@client, attributes)
-      self.token = upload.token
-    end
-
-    def to_param
-      token
-    end
-  end
-
-  class Upload < Data
-    include Create
-
-    only_send_unnested_params
-    has_many :attachments
-  end
-
-  class Locale < ReadResource; end
-  class Bookmark < Resource; end
-  class Macro < DataResource; end
-
-  module Search
-    class Result < Data; end
-
-    def self.new(client, attributes)
-      result_type = attributes["result_type"]
-
-      if result_type
-        result_type = ZendeskAPI::Helpers.modulize_string(result_type)
-        klass = ZendeskAPI.const_get(result_type) rescue nil
-      end
-
-      (klass || Result).new(client, attributes)
-    end
-
-    def self.resource_name
-      "search"
-    end
-
-    def self.model_key
-      "results"
-    end
-  end
-end

data/lib/zendesk_api/resources/ticket.rb

@@ -1,97 +0,0 @@
-module ZendeskAPI
-  class Request < Resource
-    class Comment < ReadResource
-      has_many :attachments, :inline => true
-    end
-
-    has_many :comments
-    has :organization
-  end
-
-  class TicketField < Resource; end
-
-  class TicketComment < Data
-    include Save
-
-    has_many :uploads, :class => :attachment, :inline => true
-    has :author, :class => :user
-
-    def save
-      save_associations
-      true
-    end
-
-    alias :save! :save
-  end
-
-  class TicketMetric < ReadResource; end
-
-  class Ticket < Resource
-    class Audit < DataResource; end
-
-    has :requester, :class => :user, :inline => :create
-    has :submitter, :class => :user
-    has :assignee, :class => :user
-    has :recipient, :class => :user
-    has_many :collaborators, :class => :user
-    has_many :audits
-    has :metrics, :class => :ticket_metric
-    has :group
-    has :forum_topic, :class => :topic
-    has :organization
-
-    has :comment, :class => :ticket_comment, :inline => true
-    has :last_comment, :class => :ticket_comment, :inline => true
-
-    # Gets a incremental export of tickets from the start_time until now.
-    # @param [Client] client The {Client} object to be used
-    # @param [Integer] start_time The start_time parameter
-    # @return [Collection] Collection of {Ticket}
-    def self.incremental_export(client, start_time)
-      ZendeskAPI::Collection.new(client, self, :path => "exports/tickets?start_time=#{start_time.to_i}")
-    end
-
-    # Imports a ticket through the imports/tickets endpoint
-    # @param [Client] client The {Client} object to be used
-    # @param [Hash] attributes The attributes to create.
-    # @return [Ticket] Created object or nil
-    def self.import(client, attributes)
-      ticket = new(client, attributes)
-      return unless ticket.save(:path => "imports/tickets")
-      ticket
-    end
-  end
-
-  class SuspendedTicket < ReadResource
-    include Destroy
-    put :recover
-  end
-
-  class ViewRow < DataResource
-    has :ticket
-
-    # Optional columns
-    has :group
-    has :assignee, :class => :user
-    has :requester, :class => :user
-    has :submitter, :class => :user
-    has :organization
-
-    def self.model_key
-      "rows"
-    end
-  end
-
-  class ViewExecution < Data
-    has_many :custom_fields, :class => :ticket_field
-  end
-
-  class View < ReadResource
-    has_many :rows, :class => :view_row, :path => "execute"
-    has :execution, :class => :view_execution
-
-    def self.preview(client, options = {})
-      Collection.new(client, ViewRow, options.merge(:path => "views/preview", :verb => :post))
-    end
-  end
-end

data/lib/zendesk_api/resources/user.rb

@@ -1,59 +0,0 @@
-require 'zendesk_api/resources/forum'
-
-module ZendeskAPI
-  class CRMData < DataResource; end
-  class CRMDataStatus < DataResource; end
-  class CustomRole < DataResource; end
-
-  class GroupMembership < Resource
-    has :user
-    has :group
-  end
-
-  class User < Resource
-    class Identity < Resource
-      put :make_primary
-      put :verify
-      put :request_verification
-    end
-
-    def initialize(*)
-      super
-
-      # Needed for side-loading to work
-      self.role_id = role.id if self.key?(:role)
-    end
-
-    has :organization
-
-    has :custom_role, :include => :roles
-    has :role, :inline => true, :include_key => :name
-    has :ability, :inline => true
-
-    has_many :identities
-
-    has_many :requests
-    has_many :requested_tickets, :class => :ticket, :path => 'tickets/requested'
-    has_many :ccd_tickets, :class => :ticket, :path => 'tickets/ccd'
-
-    has_many :groups
-    has_many :group_memberships
-    has_many :topics
-
-    has_many :forum_subscriptions, :class => "forum_subscription"
-    has_many :topic_subscriptions, :class => "topic_subscription"
-    has_many :topic_comments, :class => "topic/topic_comment"
-    has_many :topic_votes, :class => "topic/vote"
-
-    has :crm_data
-    has :crm_data_status, :path => 'crm_data/status'
-  end
-
-  class Organization < Resource
-    has :ability, :inline => true
-    has :group
-
-    has_many :tickets
-    has_many :users
-  end
-end