bugherd_client 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ec7b13c5d4f63ae57892ccd4ef89e6d1ab7f17e
-  data.tar.gz: 7e038d8e2144a1073d856444d13f2f5139b5aa27
+  metadata.gz: 613db28bf8edb0ace5b32f050c8c4774dc072d3a
+  data.tar.gz: c0eaa375aefbecfdd0932489723a547660ae91f9
 SHA512:
-  metadata.gz: 5744125f1d34b0dfb92e385956fae6ff9501491b0a23a4cc1d276a4bcaf5cbd2f67a73f1a79247126c8b1bd2ca90794d23da766a22c8dbdbc25aa367d7e7338e
-  data.tar.gz: c014c9e44d7c84690bc6653aad78dd1f8889e8feef09bc60186ed035cfa2ee9c30fb3003aac9b130a715f47219886120b3d6f751d923b619a6021d2acf10fd07
+  metadata.gz: de456845c1409857253cac60a58486b21da9f59cf9a5e9146ed4638a58ad8e6d4e0ff6fd66b4507029b92720a626acba33ac6cd066822093e60ec091e2023967
+  data.tar.gz: 8527719b03e5ecb6fc771c48b3a5c5d68239f8b92c352fb65cd9b324c1c5110e04e7dcf01859d6c5161cd89d6993f4594ff5702ded79e8930f4bbc6f0e8a43df

data/.gitignore

@@ -4,6 +4,7 @@
 .bundle
 .config
 .yardoc
+.envrc
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.rspec

@@ -1,2 +1,3 @@
 --color
---format progress
+--format documentation
+--tty

data/.travis.yml

@@ -2,6 +2,8 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - rbx-2.4.1
+  - rbx-2
   - ruby-head
   - jruby-19mode
   - jruby-head
@@ -16,7 +18,8 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: rbx-2
 
 notifications:
   email:
-    - jwaterfaucett@gmail.com
+    - jwaterfaucett@gmail.com

data/README.md

@@ -5,60 +5,45 @@
 
 # BugHerd Client
 
-This is a Rest Client for the BugHerd API. It fully covers all methods of the v1 and v2 API Implementations.
-Another nifty feature is that its threadsafe so you could potentially have many instances floating around and don't
-have to worry about collisions as is the case with ActiveResource.
+This is a Rest Client for the BugHerd API.
 
-## Installation
+**features:**
 
-Add this line to your application's Gemfile:
+* Threadsafe
+* Full V1 API support
+* Full V2 API support
 
-    gem 'bugherd_client'
+**ruby support:**
 
-And then execute:
+* JRuby
+* Rubinius 2+
+* MRI >= 1.9.3
 
-    $ bundle
 
-Or install it yourself as:
+## Installation
 
     $ gem install bugherd_client
 
 ## Basic Usage
 
-```ruby
-
-# create a client form an api_key, it will automatically use v2 of the BugHerd API
-client = BugherdClient::Client.new(api_key: 'someapikey')
-
-# Get information about your organization
-client.organization.get # => returns your organization information
-
-# Get a list of all users
-all_users = client.users.all # => returns a list of all users
-user = all_users.first
+For usage look in the examples folders. Examples are only kept for the latest
+version of the API so if you really want to use older versions you'll have to
+look at the source.
 
-# Find a specific project
-project = client.projects.find(1023)
-
-# Create a new Task
-task = client.tasks.create(project[:id], {
-  description: 'This is a description',
-  requester_id: user[:id],
-  status: 'backlog',
-  priority: 'normal'
-})
-
-# Create a comment
-client.comments.create(project[:id], task[:id], {
-  text: 'hey this is a comment'
-})
-
-```
+* [Setup](examples/initialization.rb)
+* [Projects](examples/projects.rb)
+* [Users & Organization](examples/users_and_organization.rb)
+* [Task & Comments](examples/tasks_and_comments.rb)
+* [Attachments](examples/attachments.rb)
+* [Webhooks](examples/webhooks.rb)
 
 ## Contributing
 
+Please note that all contributions require tests.
+
 1. Fork it ( http://github.com/<my-github-username>/bugherd_client/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Write some tests.
+6. Create new Pull Request

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# setup bundler
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup'
+
+require 'bugherd_client'
+
+# load and init pry
+begin
+  require 'pry'
+rescue LoadError
+  require 'rubygems'
+  require 'pry'
+end
+
+Pry::CLI.parse_options

data/bugherd_client.gemspec

@@ -4,24 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bugherd_client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "bugherd_client"
+  spec.name          = 'bugherd_client'
   spec.version       = BugherdClient::VERSION::STRING
-  spec.authors       = ["John Faucett"]
-  spec.email         = ["jwaterfaucett@gmail.com"]
+  spec.authors       = ['John Faucett']
+  spec.email         = ['jwaterfaucett@gmail.com']
   spec.summary       = %q{Ruby Client for the Bugherd API}
   spec.description   = %q{Ruby Client for the Bugherd Rest API}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.homepage      = 'http://jwaterfaucett.github.io/bugherd_client'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").select { |p| !(/examples/ =~ p) }
   spec.test_files    = spec.files.grep(%r{^(spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rest-client", "~> 1.6"
-  spec.add_dependency "activesupport", "> 3.0", "< 5.0"
+  spec.add_dependency 'rest-client', '~> 1.6'
+  spec.add_dependency 'hashie', '~> 3.0'
+  spec.add_dependency 'activesupport', '> 3.0', '< 5.0'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rspec", "~> 2.14"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '>= 1.5'
+  spec.add_development_dependency 'rspec', '>= 3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'webmock', '~> 1.20'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+  spec.add_development_dependency 'simplecov', '0.9.1'
 end

data/lib/bugherd_client.rb

@@ -1,29 +1,32 @@
 require 'rest_client'
+require 'hashie'
 require 'active_support'
 require 'active_support/core_ext'
 
 module BugherdClient
-  autoload :VERSION, "bugherd_client/version"
-  autoload :Client,  "bugherd_client/client"
-  autoload :Errors,  "bugherd_client/errors"
-  
+  autoload :VERSION, 'bugherd_client/version'
+  autoload :Client,  'bugherd_client/client'
+  autoload :Errors,  'bugherd_client/errors'
+
   module Resources
     module V1
-      autoload :Base,           "bugherd_client/resources/v1/base"
-      autoload :Organization,   "bugherd_client/resources/v1/organization"
-      autoload :User,           "bugherd_client/resources/v1/user"
-      autoload :Project,        "bugherd_client/resources/v1/project"
-      autoload :Task,           "bugherd_client/resources/v1/task"
-      autoload :Comment,        "bugherd_client/resources/v1/comment"
+      autoload :Base,           'bugherd_client/resources/v1/base'
+      autoload :Organization,   'bugherd_client/resources/v1/organization'
+      autoload :User,           'bugherd_client/resources/v1/user'
+      autoload :Project,        'bugherd_client/resources/v1/project'
+      autoload :Task,           'bugherd_client/resources/v1/task'
+      autoload :Comment,        'bugherd_client/resources/v1/comment'
     end
 
     module V2
-      autoload :Base,           "bugherd_client/resources/v2/base"
-      autoload :Organization,   "bugherd_client/resources/v2/organization"
-      autoload :User,           "bugherd_client/resources/v2/user"
-      autoload :Project,        "bugherd_client/resources/v2/project"
-      autoload :Task,           "bugherd_client/resources/v2/task"
-      autoload :Comment,        "bugherd_client/resources/v2/comment"
+      autoload :Base,           'bugherd_client/resources/v2/base'
+      autoload :Organization,   'bugherd_client/resources/v2/organization'
+      autoload :User,           'bugherd_client/resources/v2/user'
+      autoload :Project,        'bugherd_client/resources/v2/project'
+      autoload :Task,           'bugherd_client/resources/v2/task'
+      autoload :Comment,        'bugherd_client/resources/v2/comment'
+      autoload :Webhook,        'bugherd_client/resources/v2/webhook'
+      autoload :Attachment,     'bugherd_client/resources/v2/attachment'
     end
   end
 

data/lib/bugherd_client/client.rb

@@ -1,49 +1,70 @@
 require 'logger'
+require 'monitor'
 
 module BugherdClient
   class Client
 
     API_VERSIONS = [1,2].freeze
 
+    RESOURCE_NAMES = [
+      :organization,
+      :user,
+      :project,
+      :task,
+      :comment,
+      :webhook,
+      :attachment
+    ]
+
     DEFAULT_OPTIONS = {
       base_url: 'https://www.bugherd.com',
       api_version: 2,
-      username: '',
-      password: '',
-      api_key: '',
+      username: nil,
+      password: nil,
+      api_key: nil,
       api_rate_limiting_token: 'x',
       debug: false
     }.freeze
 
     attr_accessor :options, :connection
 
+    DEFAULT_OPTIONS.each do |option_name, v|
+      define_method("#{option_name}") { @options[option_name] }
+      define_method("#{option_name}=") { |value| @options[option_name] = value }
+    end
+
     def initialize(opts={}, &block)
-      @options = DEFAULT_OPTIONS.merge(opts)
-      yield(self) if block_given?
-      establish_connection!
+      mutex = Monitor.new
+      mutex.synchronize do
+        @options = DEFAULT_OPTIONS.merge(opts)
+        yield(self) if block_given?
+        establish_connection!
+      end
     end
 
     def establish_connection!
       check_options!
       username, password = build_credentials
-      
+
       if @options[:debug]
         RestClient.log        = ::Logger.new($stderr)
         RestClient.log.level  = ::Logger::DEBUG
       end
-      self.connection = RestClient::Resource.new(base_url, user: username, password: password)
+
+      resource_klass = Class.new(RestClient::Resource)
+      self.connection = resource_klass.new(base_url, user: username, password: password)
     end
-    
+
     def base_url
       File.join(options[:base_url], "api_v#{options[:api_version]}")
     end
 
     def check_options!
       if !@options[:api_key] && !(@options[:username] && @options[:password])
-        raise BugherdClient::Errors::InvalidOption, "api_key or username and password is required"
+        raise BugherdClient::Errors::InvalidOption, 'api_key or username and password is required'
       end
       unless API_VERSIONS.include?(@options[:api_version])
-        raise BugherdClient::Errors::InvalidOption, "api_version must be #{API_VERSIONS.join(',')}"
+        raise(BugherdClient::Errors::InvalidOption.new("api_version must be #{API_VERSIONS.join(',')}"))
       end
     end
 
@@ -57,18 +78,23 @@ module BugherdClient
 
     def resource(name)
       version = self.options[:api_version]
-      klass = "BugherdClient::Resources::V#{version}::#{name.to_s.classify}".constantize
+      version_base = "BugherdClient::Resources::V#{version}".constantize
+      klass_name   = name.to_s.classify.to_sym
+      unless version_base.constants.include?(klass_name)
+        raise(BugherdClient::Errors::NotAvailable.new(version, klass_name))
+      end
+      klass = version_base.const_get(klass_name)
       klass.new(self.connection, @options)
     end
 
-    # 
-    # Resources
-    # 
-    [:organization, :user, :project, :task, :comment].each do |resource_name|
+    #
+    # generate RESTful resource factory methods
+    #
+    RESOURCE_NAMES.each do |resource_name|
       define_method("#{resource_name.to_s.pluralize}") do
-        resource("#{resource_name}")
+        resource(resource_name.to_s)
       end
     end
 
   end
-end
+end

data/lib/bugherd_client/errors.rb

@@ -2,27 +2,41 @@ module BugherdClient
   module Errors
 
     class InvalidOption < StandardError
-      def initialize(msg="invalid option")
+      def initialize(msg='invalid option')
         super(msg)
       end
     end
 
     class NotAvailable < StandardError
-      def initialize(api_version, msg="")
+      def initialize(api_version, msg='')
         super("#{msg} not available in API v#{api_version}")
       end
     end
 
+    class InvalidQueryKey < StandardError
+      def initialize(given = '', valid_keys = [])
+        super("invalid query key: got #{given} but expected one of #{valid_keys.join(',')}")
+      end
+    end
+
+    class HttpRequestError < StandardError
+      attr_accessor :http_code
+      def initialize(message = '', code = 500)
+        super(message)
+        @http_code = code
+      end
+    end
+
     class UnsupportedMethod < StandardError
-      def initialize(api_version="")
+      def initialize(api_version='')
         super("Method supported in API version #{api_version}")
       end
     end
 
     class UnsupportedAttribute < StandardError
-      def initialize(api_version="", attrs=[])
+      def initialize(api_version='', attrs=[])
         super("Attributes (#{attrs.join(',')}) supported in #{api_version}")
       end
     end
   end
-end
+end

data/lib/bugherd_client/resources/v1/base.rb

@@ -23,7 +23,7 @@ module BugherdClient
           @connection, @options = conn, opts
         end
 
-        def send_request(method="GET", path="", params={}, headers={})
+        def send_request(method='GET', path='', params={}, headers={})
           headers = DEFAULT_HEADER_ATTRS.merge(headers)
           params.merge!(headers)
           method_name = method.to_s.downcase
@@ -52,4 +52,4 @@ module BugherdClient
 
     end
   end
-end
+end

data/lib/bugherd_client/resources/v1/comment.rb

@@ -30,4 +30,4 @@ module BugherdClient
 
     end
   end
-end
+end

data/lib/bugherd_client/resources/v1/project.rb

@@ -25,7 +25,7 @@ module BugherdClient
         # attributes: name, devurl, is_public, is_active
         #
         def create(attributes={})
-          raw_response = post_request("projects", project: attributes)
+          raw_response = post_request('projects', project: attributes)
           parse_response(raw_response, :project)
         end
 
@@ -37,7 +37,7 @@ module BugherdClient
           parse_response(raw_response, :project)
         end
 
-        # 
+        #
         # Delete a project and all associated data. Use with care, deleted projects cannot be recovered.
         #
         def delete(project_id)
@@ -46,7 +46,7 @@ module BugherdClient
         end
 
       end
-      
+
     end
   end
-end
+end