happi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c253d43249392dcece9180d9df4016fb24fb9703
-  data.tar.gz: 8ecf4749f3d5e4f5a835405daee249ed431326c4
+  metadata.gz: 9dbbe19b69447b59fcdffc793300f8058b61d87e
+  data.tar.gz: 1551a9532ba36b03ead3746239880e90eee83ccb
 SHA512:
-  metadata.gz: 7edea26416999669e165e569290b1d171c2194d81acf5b3ae0247115218259cc37a0182da22fc30879385e45f6f5a593feb195e3bb49afe5d71f9e8b84ecafd6
-  data.tar.gz: 6be9fbded9eb24829e0f310c7cee85553667e27e31ed7b666f23b8082b21b34a709282911418130093199d5c66839816f3f1114678184533f9e58514006940ef
+  metadata.gz: 7812c0d9fc728a44e021a95914be86d03dce8e65136748258e3620c4e916d2916796a068e1f7eb947a49b897daac60cd2fc58cb9eb1ba68f866a31bad0c9e40e
+  data.tar.gz: b34a4009a5fed72e54209ae705ef770ada24d74cd07c83aff7074252b45953ab37a7501a472e6cd9501470d5bdd6def8f0965918471422318e4fae2272b5d701

data/README.md

@@ -1,6 +1,7 @@
 # Happi
 
-Happi - preconfigured faraday client
+Happi is a pre-configured Faraday client designed for easy access to RESTful
+HTTP APIs. It assumes URLS of the form `https://hostname.com/api/v1/something`.
 
 ## Installation
 
@@ -12,61 +13,80 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install happi
+Happi stores its configuration as class-level state, so it's important to
+derive your own client from `Happi::Client` rather than using it directly,
+which can cause requests to be sent to the wrong endpoint.
 
-## Usage
+```ruby
+require 'happi'
 
-    require 'happi'
+class MyClient < Happi::Client
+end
 
-    Happi::Client.configure do |config|
-      config.host = 'http://localhost:3000'
-    end
+MyClient.configure do |config|
+  config.host = 'http://localhost:3000'
+end
 
-    client = Happi::Client.new(
-      oauth_token: '63ba06720acf97959f5ba3e3fe1020bf69a7596e2fe3091f821a35cdfe615ceb')
+client = Myclient.new(
+  oauth_token: '63ba06720acf97959f5ba3e3fe1020bf69a7596e2fe3091f821a35cdfe615ceb')
 
-    templates = client.get('templates')[:templates]
-    templates.each do |template|
-      puts template[:name]
-    end
+templates = client.get('templates')[:templates]
+templates.each do |template|
+  puts template[:name]
+end
 
-    response = client.post('templates', template: {name: 'test',
-                                                   file: Happi::File.new(File.join(File.dirname(__FILE__), 'spec/fixtures/award.docx')) } )
-    template = response[:template]
+response = client.post('templates', template: {name: 'test',
+                                               file: Happi::File.new(File.join(File.dirname(__FILE__), 'spec/fixtures/award.docx')) } )
+template = response[:template]
 
-    templates = client.get('templates')[:templates]
-    template = client.get('templates/1')[:template]
+templates = client.get('templates')[:templates]
+template = client.get('templates/1')[:template]
 
-    template = client.patch("templates/#{template[:id]}",
-      template: {id: template[:id],
-      name: 'test' }
-    )[:template]
+template = client.patch("templates/#{template[:id]}",
+  template: {id: template[:id],
+  name: 'test' }
+)[:template]
 
-    client.get('documents')[:documents].each do |document|
-      puts document[:name]
-    end
+client.get('documents')[:documents].each do |document|
+  puts document[:name]
+end
 
-    document = client.post('documents',
-        document: {template_id: template[:id],
-        name: 'Test Document',
-        params: JSON.dump({name: 'Test'}) } )[:document]
+document = client.post('documents',
+    document: {template_id: template[:id],
+    name: 'Test Document',
+    params: JSON.dump({name: 'Test'}) } )[:document]
 
-    puts document[:id]
+puts document[:id]
+```
 
 ## Configuration
 
 ```ruby
-Happi::Client.configure do |config|
+MyClient.configure do |config|
   config.host = 'http://localhost:8080'
   config.port = 443
   config.timeout = 60
   config.version = 'v1'
   config.use_json = false
+  config.log_level = :debug
 end
 ```
 
+A class deriving from `Happi::Client` can be configured with the following
+paramters:
+
+- **config.host** - the hostname of the server
+- **config.port** - the TCP port to which requests will be sent.
+- **config.timeout** - the maximum time to allow requests to take.
+- **config.version** - the API version to interpolate in the URL
+- **config.use_json** - when `true`, encode requests as JSON, and intepret
+responses as JSON.
+- **config.log_level** - when set to `:debug`, will log full request bodies and
+paramaters, but will only log URL otherwise. Be aware: setting this to `:debug`
+in data-heavy applications can lead to very large log files.
+
 ## Contributing
 
 1. Fork it

data/lib/happi/error.rb

@@ -1,12 +1,12 @@
 class Happi::Error < StandardError
-  class ClientError < self
-    attr_reader :response
+  attr_reader :response
 
-    def initialize(msg = nil, response = nil)
-      super(msg)
-      @response = response
-    end
+  def initialize(msg = nil, response = nil)
+    super(msg)
+    @response = response
+  end
 
+  class ClientError < self
     def message
       "A client error occurred"
     end

data/lib/happi/version.rb

@@ -1,3 +1,3 @@
 module Happi
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/script/buildkite.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+set -e
+
+REVISION=https://github.com/$BUILDBOX_PROJECT_SLUG/commit/$BUILDBOX_COMMIT
+
+echo '--- setting ruby version'
+rbenv local 2.1.5
+
+echo '--- bundling'
+bundle install -j $(nproc) --without development production --quiet
+
+echo '--- running specs'
+if bundle exec rspec; then
+  echo "[Successful] $BUILDBOX_PROJECT_SLUG - Build - $BUILDBOX_BUILD_URL - Commit - $REVISION" | hipchat_room_message -t $HIPCHAT_TOKEN -r $HIPCHAT_ROOM -f "Buildbox" -c "green"
+else
+  echo "[Failed] Build $BUILDBOX_PROJECT_SLUG - Build - $BUILDBOX_BUILD_URL - Commit - $REVISION" | hipchat_room_message -t $HIPCHAT_TOKEN -r $HIPCHAT_ROOM -f "Buildbox" -c "red"
+  exit 1;
+fi
+

data/spec/error_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Happi::Error do
+  describe '.new' do
+    context 'with 1 argument' do
+      let(:error) { Happi::Error.new('message') }
+      specify { expect(error.message).to eq('message') }
+      specify { expect(error.response).to be nil }
+    end
+
+    context 'with 2 arguments' do
+      let(:error) { Happi::Error.new('message', 'response') }
+      specify { expect(error.message).to eq('message') }
+      specify { expect(error.response).to eq('response') }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: happi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - John D'Agostino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -200,8 +200,10 @@ files:
 - lib/happi/error.rb
 - lib/happi/file.rb
 - lib/happi/version.rb
+- script/buildkite.sh
 - spec/client_spec.rb
 - spec/configuration_spec.rb
+- spec/error_spec.rb
 - spec/file_spec.rb
 - spec/fixtures/award.docx
 - spec/spec_helper.rb
@@ -232,6 +234,7 @@ summary: Simple faraday client wrapper preconfigured for specific usecase
 test_files:
 - spec/client_spec.rb
 - spec/configuration_spec.rb
+- spec/error_spec.rb
 - spec/file_spec.rb
 - spec/fixtures/award.docx
 - spec/spec_helper.rb