bugherd_client 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0bcd4453cc95825470d7c96cd95a694dc4942bd
-  data.tar.gz: d3a15e2ac22b153ae89fabf103a7c8123f4a2d5c
+  metadata.gz: 4ec7b13c5d4f63ae57892ccd4ef89e6d1ab7f17e
+  data.tar.gz: 7e038d8e2144a1073d856444d13f2f5139b5aa27
 SHA512:
-  metadata.gz: ffd91b8c06845d81ea2d86210e927b1e678bbed9ef931b9d3cfda2e0af9ed04a043847f9714dd4ad5ebf5d3038181f920c4aecd4e49085f8552952ee58eab8b2
-  data.tar.gz: 980f304b6c230cfcd048d67c8d7bcd3f10bae346906d543327493850acd2be7bfc1508c572e3eabf764943cbd7437a6f96ddaa56d1e6fe172429dbc754f77e95
+  metadata.gz: 5744125f1d34b0dfb92e385956fae6ff9501491b0a23a4cc1d276a4bcaf5cbd2f67a73f1a79247126c8b1bd2ca90794d23da766a22c8dbdbc25aa367d7e7338e
+  data.tar.gz: c014c9e44d7c84690bc6653aad78dd1f8889e8feef09bc60186ed035cfa2ee9c30fb3003aac9b130a715f47219886120b3d6f751d923b619a6021d2acf10fd07

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+script:
+  - bundle exec rspec
+
+branches:
+  only:
+    - master
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+
+notifications:
+  email:
+    - jwaterfaucett@gmail.com

data/README.md

@@ -1,6 +1,11 @@
-# BugherdClient
+[![Gem Version](https://badge.fury.io/rb/bugherd_client.svg)](http://badge.fury.io/rb/bugherd_client)
+[![Dependency Status](https://gemnasium.com/jwaterfaucett/bugherd_client.svg)](https://gemnasium.com/jwaterfaucett/bugherd_client)
+[![Build Status](https://travis-ci.org/jwaterfaucett/bugherd_client.svg?branch=master)](https://travis-ci.org/jwaterfaucett/bugherd_client)
 
-This is a Rest Client for the Bugherd API. It fully covers all methods of the v1 and v2 API Implementations.
+
+# 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.
 
@@ -22,21 +27,31 @@ Or install it yourself as:
 
 ```ruby
 
-client = BugherdClient::Client.new(api_key: 'someapikey', api_version: 2) # api_version 2 is the default
+# 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
-client.users.all # => returns a list of all users
+
+# Get a list of all users
+all_users = client.users.all # => returns a list of all users
+user = all_users.first
+
+# Find a specific project
 project = client.projects.find(1023)
-user = client.users.all.first
 
-client.tasks.create(project[:id], {
-  description: 'Some description',
+# Create a new Task
+task = client.tasks.create(project[:id], {
+  description: 'This is a description',
   requester_id: user[:id],
-  status: BugherdClient::Resources::Task::STATUS_BACKLOG,
-  priority: BugherdClient::Resources::Task::PRIORITY_NORMAL,
-  external_id: 'my-external-app-123'
+  status: 'backlog',
+  priority: 'normal'
 })
 
-
+# Create a comment
+client.comments.create(project[:id], task[:id], {
+  text: 'hey this is a comment'
+})
 
 ```
 

data/lib/bugherd_client/client.rb

@@ -3,7 +3,7 @@ require 'logger'
 module BugherdClient
   class Client
 
-    VALID_API_VERSIONS = [1,2].freeze
+    API_VERSIONS = [1,2].freeze
 
     DEFAULT_OPTIONS = {
       base_url: 'https://www.bugherd.com',
@@ -13,12 +13,12 @@ module BugherdClient
       api_key: '',
       api_rate_limiting_token: 'x',
       debug: false
-    }
+    }.freeze
 
     attr_accessor :options, :connection
 
-    def initialize(options={}, &block)
-      @options = DEFAULT_OPTIONS.merge(options)
+    def initialize(opts={}, &block)
+      @options = DEFAULT_OPTIONS.merge(opts)
       yield(self) if block_given?
       establish_connection!
     end
@@ -31,9 +31,7 @@ module BugherdClient
         RestClient.log        = ::Logger.new($stderr)
         RestClient.log.level  = ::Logger::DEBUG
       end
-
       self.connection = RestClient::Resource.new(base_url, user: username, password: password)
-      
     end
     
     def base_url
@@ -44,23 +42,23 @@ module BugherdClient
       if !@options[:api_key] && !(@options[:username] && @options[:password])
         raise BugherdClient::Errors::InvalidOption, "api_key or username and password is required"
       end
-      unless VALID_API_VERSIONS.include?(@options[:api_version])
-        raise BugherdClient::Errors::InvalidOption, "api_version must be #{VALID_API_VERSIONS.join(',')}"
+      unless API_VERSIONS.include?(@options[:api_version])
+        raise BugherdClient::Errors::InvalidOption, "api_version must be #{API_VERSIONS.join(',')}"
       end
     end
 
     def build_credentials
-      if @options[:api_key]
+      if @options[:api_key].present?
         [@options[:api_key], @options[:api_rate_limiting_token]]
       else
         [@options[:username], @options[:password]]
       end
     end
 
-    def resource(name, opts={})
+    def resource(name)
       version = self.options[:api_version]
       klass = "BugherdClient::Resources::V#{version}::#{name.to_s.classify}".constantize
-      klass.new(self.connection, self.options)
+      klass.new(self.connection, @options)
     end
 
     # 

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

@@ -6,7 +6,10 @@ module BugherdClient
 
       class Base
 
-        DEFAULT_HEADERS = { content_type: :json, accept: :json }
+        DEFAULT_HEADER_ATTRS = {
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json'
+        }.freeze
 
         #
         # Return a list of available methods in a Resource
@@ -21,7 +24,7 @@ module BugherdClient
         end
 
         def send_request(method="GET", path="", params={}, headers={})
-          headers = DEFAULT_HEADERS.merge(headers)
+          headers = DEFAULT_HEADER_ATTRS.merge(headers)
           params.merge!(headers)
           method_name = method.to_s.downcase
           self.connection[path].__send__(method_name, params)
@@ -35,7 +38,12 @@ module BugherdClient
 
         def parse_response(response, root_element=nil)
           if root_element
-            JSON.parse(response)[root_element.to_s]
+            pr = JSON.parse(response)
+            if pr.is_a?(Hash) and pr.has_key?(root_element)
+              pr[root_element]
+            else
+              pr
+            end
           else
             JSON.parse(response)
           end

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

@@ -11,8 +11,14 @@ module BugherdClient
           :accept => :json
         }.freeze
 
-        attr_accessor :connection, :options
+        #
+        # Return a list of available methods in a Resource
+        #
+        def api_methods
+          self.class.instance_methods(false)
+        end
 
+        attr_accessor :connection, :options
         def initialize(conn, opts={})
           @connection, @options = conn, opts
         end

data/lib/bugherd_client/version.rb

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

data/spec/bugherd_client/client_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+
+describe BugherdClient::Client do
+
+  it "should list API_VERSIONS 1 and 2" do
+    BugherdClient::Client::API_VERSIONS.should include(1)
+    BugherdClient::Client::API_VERSIONS.should include(2)
+  end
+
+  context "default options" do
+  
+    it "should have a default api_version of 2" do
+      BugherdClient::Client::DEFAULT_OPTIONS[:api_version].should eq(2)
+    end
+
+    it "should have an api_rate_limiting_token that defaults to x" do
+      BugherdClient::Client::DEFAULT_OPTIONS[:api_rate_limiting_token].should eq('x')
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bugherd_client'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugherd_client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - John Faucett
@@ -94,6 +94,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -114,6 +116,8 @@ files:
 - lib/bugherd_client/resources/v2/task.rb
 - lib/bugherd_client/resources/v2/user.rb
 - lib/bugherd_client/version.rb
+- spec/bugherd_client/client_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -138,4 +142,6 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby Client for the Bugherd API
-test_files: []
+test_files:
+- spec/bugherd_client/client_spec.rb
+- spec/spec_helper.rb