bugherd_client 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bc66534748aeba97dd104812c820c8c386b3cdb
-  data.tar.gz: 8b21ec8ef3a8e372fa7d2f36a23c7958f7378251
+  metadata.gz: a0bcd4453cc95825470d7c96cd95a694dc4942bd
+  data.tar.gz: d3a15e2ac22b153ae89fabf103a7c8123f4a2d5c
 SHA512:
-  metadata.gz: 9667fd201184c2cfedc7574570a5a3df73bf7fdd03cbd104fdbcb807d5ad48ee1b056db40e861c3a1da2d9ae9159ecc962874cb0d2367bbc5bd925fa87103ada
-  data.tar.gz: 17ce74ba5e174e91cd08354795eb37aa9393c75a87c40456438e818148a1075d9420c63465c37ec6f2d4687d4555f8c352c3fabfa65e63d7da5a5674b623011b
+  metadata.gz: ffd91b8c06845d81ea2d86210e927b1e678bbed9ef931b9d3cfda2e0af9ed04a043847f9714dd4ad5ebf5d3038181f920c4aecd4e49085f8552952ee58eab8b2
+  data.tar.gz: 980f304b6c230cfcd048d67c8d7bcd3f10bae346906d543327493850acd2be7bfc1508c572e3eabf764943cbd7437a6f96ddaa56d1e6fe172429dbc754f77e95

data/lib/bugherd_client/client.rb

@@ -11,6 +11,7 @@ module BugherdClient
       username: '',
       password: '',
       api_key: '',
+      api_rate_limiting_token: 'x',
       debug: false
     }
 
@@ -27,8 +28,8 @@ module BugherdClient
       username, password = build_credentials
       
       if @options[:debug]
-        RestClient.log = ::Logger.new($stderr)
-        RestClient.log.level = Logger::DEBUG
+        RestClient.log        = ::Logger.new($stderr)
+        RestClient.log.level  = ::Logger::DEBUG
       end
 
       self.connection = RestClient::Resource.new(base_url, user: username, password: password)
@@ -50,7 +51,7 @@ module BugherdClient
 
     def build_credentials
       if @options[:api_key]
-        [@options[:api_key], 'x']
+        [@options[:api_key], @options[:api_rate_limiting_token]]
       else
         [@options[:username], @options[:password]]
       end

data/lib/bugherd_client/errors.rb

@@ -7,6 +7,12 @@ module BugherdClient
       end
     end
 
+    class NotAvailable < StandardError
+      def initialize(api_version, msg="")
+        super("#{msg} not available in API v#{api_version}")
+      end
+    end
+
     class UnsupportedMethod < StandardError
       def initialize(api_version="")
         super("Method supported in API version #{api_version}")

data/lib/bugherd_client/version.rb

@@ -2,7 +2,7 @@ module BugherdClient
   module VERSION
     MAJOR = 0
     MINOR = 0
-    PATCH = 4
+    PATCH = 5
 
     STRING = [MAJOR,MINOR,PATCH].join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugherd_client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - John Faucett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -102,12 +102,6 @@ files:
 - lib/bugherd_client.rb
 - lib/bugherd_client/client.rb
 - lib/bugherd_client/errors.rb
-- lib/bugherd_client/resources/base.rb
-- lib/bugherd_client/resources/comment.rb
-- lib/bugherd_client/resources/organization.rb
-- lib/bugherd_client/resources/project.rb
-- lib/bugherd_client/resources/task.rb
-- lib/bugherd_client/resources/user.rb
 - lib/bugherd_client/resources/v1/base.rb
 - lib/bugherd_client/resources/v1/comment.rb
 - lib/bugherd_client/resources/v1/project.rb

data/lib/bugherd_client/resources/base.rb

@@ -1,36 +0,0 @@
-require 'json'
-
-module BugherdClient
-  module Resources
-    class Base
-
-      DEFAULT_HEADERS = { content_type: :json, accept: :json }
-
-      attr_accessor :connection, :options
-      def initialize(conn, opts={})
-        @connection, @options = conn, opts
-      end
-
-      def send_request(method="GET", path="", params={}, headers={})
-        headers = DEFAULT_HEADERS.merge(headers)
-        params.merge!(headers)
-        method_name = method.to_s.downcase
-        self.connection[path].__send__(method_name, params)
-      end
-
-      [:get, :post, :put, :patch, :delete].each do |method_name|
-        define_method("#{method_name}_request") do |path, params={}|
-          send_request(method_name, path, params)
-        end
-      end
-
-      def parse_response(response, root_element=nil)
-        if root_element
-          JSON.parse(response)[root_element.to_s]
-        else
-          JSON.parse(response)
-        end
-      end
-    end
-  end
-end

data/lib/bugherd_client/resources/comment.rb

@@ -1,23 +0,0 @@
-module BugherdClient
-  module Resources
-    class Comment < Base
-
-      #
-      # Get a paginated list of comments for a task.
-      #
-      def all(project_id, task_id)
-        raw_response = get_request("projects/#{project_id}/tasks/#{task_id}/comments")
-        parse_response(raw_response, :comments)
-      end
-
-      #
-      # Create a comment
-      # attributes: text, user_id or email
-      def create(project_id, task_id, attributes={})
-        raw_response = post_request("projects/#{project_id}/tasks/#{task_id}/comments", comment: attributes)
-        parse_response(raw_response)
-      end
-
-    end
-  end
-end

data/lib/bugherd_client/resources/organization.rb

@@ -1,14 +0,0 @@
-module BugherdClient
-  module Resources
-    class Organization < Base
-
-      #
-      # Get more detail of your account.
-      # 
-      def get
-        raw_response = self.connection['organization'].get
-        parse_response(raw_response, :organization)
-      end
-    end
-  end
-end

data/lib/bugherd_client/resources/project.rb

@@ -1,76 +0,0 @@
-module BugherdClient
-  module Resources
-    class Project < Base
-
-      #
-      # Get more detail of your account.
-      # 
-      def all
-        raw_response = get_request('projects')
-        parse_response(raw_response, :projects)
-      end
-
-      #
-      # Show details for a specific project
-      # 
-      def find(project_id)
-        raw_response = get_request("projects/#{project_id}")
-        parse_response(raw_response, :project)
-      end
-
-      #
-      # Create a Project, will initially have no members
-      # attributes: name, devurl, is_public, is_active
-      # 
-      def create(attributes={})
-        raw_response = post_request("projects", project: attributes)
-        parse_response(raw_response, :project)
-      end
-
-      #
-      # Update settings for an existing project under your control (ie: only the ones you own).
-      # API: 1,2
-      def update(project_id, attributes={})
-        raw_response = put_request("projects/#{project_id}", project: attributes)
-        parse_response(raw_response, :project)
-      end
-
-      # 
-      # Delete a project and all associated data. Use with care, deleted projects cannot be recovered.
-      # API: 1,2
-      def delete(project_id)
-        raw_response = delete_request("projects/#{project_id}")
-        parse_response(raw_response)
-      end
-
-      # 
-      # Add an existing guest to a project, or invite someone by email address.
-      # required: project_id
-      # attributes: user_id, email
-      # API: 2
-      def add_guest(project_id, attributes={})
-        raw_response = post_request("projects/#{project_id}/add_guest", attributes)
-        parse_response(raw_response)
-      end
-
-      # 
-      # Add an existing guest to a project, or invite someone by email address.
-      # required: project_id
-      # attributes: user_id
-      # 
-      def add_member(project_id, attributes={})
-        raw_response = post_request("projects/#{project_id}/add_member", attributes)
-        parse_response(raw_response)
-      end
-
-
-      #
-      # Get all active projects
-      # 
-      def active
-        raw_response = get_request('projects/active')
-        parse_response(raw_response, :projects)
-      end
-    end
-  end
-end

data/lib/bugherd_client/resources/task.rb

@@ -1,56 +0,0 @@
-module BugherdClient
-  module Resources
-    class Task < Base
-
-      PRIORITIES = ['not set', 'critical', 'important', 'normal','minor']
-      PRIORITIES.each do |priority|
-        Task.const_set("PRIORITY_#{priority.gsub(' ', '').upcase}", priority)
-      end
-
-      STATUSES   = ['backlog','todo','doing','done','closed']
-      STATUSES.each do |status|
-        Task.const_set("STATUS_#{status.upcase}", status)
-      end
-
-      #
-      # Get a full list of tasks for a project, including archived tasks.
-      # filters: updated_since, created_since, status, priority, tag and external_id
-      def all(project_id, filter_attributes={})
-        params = filter_attributes.empty? ? {} : { params: filter_attributes }
-        raw_response = get_request("projects/#{project_id}/tasks", params)
-        parse_response(raw_response, :tasks)
-      end
-
-      #
-      # List details of a task in a given project, includes all data including comments, attachments, etc.
-      #
-      def find(project_id, task_id)
-        raw_response = get_request("projects/#{project_id}/tasks/#{task_id}")
-        parse_response(raw_response)
-      end
-
-      #
-      # Create a new Task
-      # attributes: 
-      #   description, priority, status, tag_names(Array), 
-      #   requester_id or requester_email, 
-      #   assigned_to_id or assigned_to_email
-      #   external_id
-      # if status is null the Task is automatically put in the Feedback panel
-      # "requester_email" can be any email address while "assigned_to_email" needs to be of a current project member.
-      # Values for "priority" are not set, critical, important, normal, and minor.
-      # Values for "status" are backlog, todo, doing, done, and closed. Omit this field or set as "null" to send tasks to the Feedback panel.
-      # External ID is an API-only field. It cannot be set from the BugHerd application, only using the API. An external ID can be used to track originating IDs from other systems in BugHerd bugs.
-      def create(project_id, attributes={})
-        raw_response = post_request("projects/#{project_id}/tasks", task: attributes)
-        parse_response(raw_response)
-      end
-
-      def update(project_id, task_id, attributes={})
-        raw_response = put_request("projects/#{project_id}/tasks/#{task_id}", task: attributes)
-        parse_response(raw_response)
-      end
-
-    end
-  end
-end

data/lib/bugherd_client/resources/user.rb

@@ -1,31 +0,0 @@
-module BugherdClient
-  module Resources
-    class User < Base
-
-      #
-      # See all the people in your account.
-      # API: 1,2
-      def all
-        raw_response = get_request('users')
-        parse_response(raw_response, :users)
-      end
-
-      #
-      # See all your account members
-      #
-      def members
-        raw_response = get_request('users/members')
-        parse_response(raw_response, :users)
-      end
-
-      #
-      # See all the guest in your account
-      #
-      def guests
-        raw_response = get_request('users/guests')
-        parse_response(raw_response, :users)
-      end
-
-    end
-  end
-end