saddle 0.0.10 → 0.0.11

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmI5ZWE4OTY2MDdhYTU0ODhjMGRlNjQ4NTVlZmYyMDExZWRkMWM0OQ==
+    MzU0YzZkNmQ2YmI0MTE3MGU4NDEwODFkZjhiMjNiMzAzNjNlZWVhZg==
   data.tar.gz: !binary |-
-    MTJjNzUzN2UwYjRiNThiNDVmNzk1YjM1YTczOWEzODdkNThhYzFhOA==
+    OTBmMWNkZGJmYjFhMGY2Njc4ZGUxYzZlZDljZDFmNDZkOTExY2QyOQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MTg2NDg1NzkwMWM4NzE4YzEzODNkMzJmNGQ0NTYwNjc5NjAwMThlNzNkOWYx
-    MjYxNTJlYzFiMmMxNTJmYjBiOTc0NDBjNDQzYmM2NGY5ZDExYjc0NTY0ZWUx
-    OTNmMTEyODVlN2RlMTAyZjk4MGVjMGZlMjliN2I4OWQ0ZDQ2MTQ=
+    YjBmMWJhZDE2NjQ2ZTEzNTE5OGU1YTlkYjY4NjVkNTUyZDIyNmQ2NDkxODRk
+    NzVjYjAxOGM0YmMwMjAwYjdjZDViNTZlZTY0ZWI0NDJkZTgzMTZmOGQ0MjI2
+    NTAxY2RkZThiNDFjMjRlNThlZjRmOGQ0NjM1NTg5Y2ZiNmRmNGQ=
   data.tar.gz: !binary |-
-    NWFiOWQ1OTMzMTViM2M0ZGEzOGNmODdiMTQwOTM2NWIzYzMyNjc1OGFjNmQ5
-    N2RlNDBmZTMzYTE0ODkwOWQ4YzVkY2NjY2U5MDk2Nzc1MWVmZTViYTgyNjhk
-    M2I2NzU3NTg0ZjdkNDA5OWQ2N2U5ODQyZGFhOGUzODlkMDgyMzU=
+    MDgxMWQ5MGFmYzFkNTEwYWZmMmEzYTdlZjA4MTViODZiNjkyNzIyOTk2MTEy
+    ZjYwMTg5ODJlZTEyYjY0MTdmZjcxNWExM2M1YzQ4M2JiYTM0ZWVhNDg1ZGJj
+    ZGZmOGFmZTk1Y2VkY2U3OGQ4ZjFjNDcxMjkxMWZjNGFhOTBlODI=

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 
 gem 'activesupport', '>= 3.0', :require => 'active_support'
-gem 'faraday', '~> 0.8.6'
+gem 'faraday', '~> 0.8.7'
 gem 'faraday_middleware', '~> 0.9.0'
 
 group :test do

data/Gemfile.lock

@@ -4,13 +4,13 @@ GEM
     activesupport (3.2.13)
       i18n (= 0.6.1)
       multi_json (~> 1.0)
-    diff-lcs (1.2.1)
-    faraday (0.8.6)
+    diff-lcs (1.2.4)
+    faraday (0.8.7)
       multipart-post (~> 1.1)
     faraday_middleware (0.9.0)
       faraday (>= 0.7.4, < 0.9)
     i18n (0.6.1)
-    multi_json (1.7.2)
+    multi_json (1.7.3)
     multipart-post (1.2.0)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
@@ -20,14 +20,14 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-instafail (0.2.4)
-    rspec-mocks (2.13.0)
+    rspec-mocks (2.13.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   activesupport (>= 3.0)
-  faraday (~> 0.8.6)
+  faraday (~> 0.8.7)
   faraday_middleware (~> 0.9.0)
   rspec (~> 2.13.0)
   rspec-instafail (~> 0.2)

data/README.md

@@ -2,38 +2,59 @@
 
 Hey nerd! Wrangle your SOA!
 
+Saddle makes writing service clients as easy as giving high fives. :hand:
 
-Saddle makes writing service clients as easy as giving high fives.©™®℗☃✓
-
-It's a full-featured generic consumer layer for you to build API client implementations on top of.
+It's a full-featured, generic consumer layer for you to build API client implementations with.
 
 
 ## about
 
 Ok, I love high fives, but what does Saddle do for me?
 
-I'm glad you asked fellow nerd! Do you like automatic retries? Automatic multi-part file posting? I know I sure do!
-
-Do you like sending your POSTs url-encoded? That's okay, I still love you anyways and Saddle has your back. Does your rampant OCD refuse to let you post in anything less structured than JSON? High five nerd, Saddle bleeds OCD. Just set your :post_style flag and fuhgedaboutit!
+Saddle is a framework that makes it exceptionally easy to write HTTP API clients. It abstracts away a lot of the repetitive work and lets you focus on your business logic. It also provides a simple middleware interface that makes it easy to extend functionality.
 
-For an example of a concrete implementation, see [saddle-example](https://github.com/mLewisLogic/saddle-example)
+Saddle enables you to create beautifully stable and functionaly API clients, in the fewest lines of code possible.
 
 
 ## features
-* set default connection settings for your implementation
-* post urlencoded or JSON
-* auto-parse JSON responses
-* automatic retries and exception throwing
+
+### client
+* Specifying default connection settings for your client makes usage simple
+* Automatic call tree construction, based upon module/class namespace
+* Easily integrate with logging systems (currently supports statsd & Airbrake)
+* Support simple testing of your client
+
+### requests
+* Post urlencoded or JSON (handles multipart file posts as well)
+* Auto-parse JSON responses
+* Strictly enforce request timeouts (client-wide or endpoint specific timeouts)
+
+### error handling
+* Automatic retries with exponential backoff
+* Turns 4xx and 5xx responses into exceptions
+* If desired, silently return default values upon exception
 
 
 ## guide
-1. Inherit your endpoint from BaseEndpoint and call .get or .post within its action methods
-2. Place those endpoints in the *endpoints* directory at the root of your client. Nest them if you like.
-3. Inherit your client from Saddle
-4. Call client.endpoint.action()
+
+### concrete example
+[saddle-example](https://github.com/mLewisLogic/saddle-example)
+
+### client construction
+0. For the sake of cleanliness, pick a namespace that everything related to your client should live in. For this example, we'll use _SaddleExample_.
+1. Inherit your client class (_SaddleExample::Client_)from _Saddle::Client_
+2. Create an _endpoints_ directory at the same level as your client class file
+3. Create endpoint classes in the _endpoints_ directory that inherit from _Saddle::TraversalEndpoint_ and are under the _SaddleExample::Endpoints_ namespace module
+    1. Give these endpoints methods that call _get_ or _post_ to perform the actual request
+    2. Their module/class namespace determines how they are accessed in the client's call tree. For example, the get_all() in _SaddleExample::Endpoints::Fish::Guppy_ would be accessed by:
+
+        client.fish.guppy.get_all()
+
+4. Initialize an instance of your client. ex:
+
+        saddle_example_client = SaddleExample::Client.create
+
 
 
 ## todo
-* xml posting
-* xml parsing
-* clean up custom middleware loading interface
+* xml posting/parsing

data/lib/saddle/version.rb

@@ -1,3 +1,3 @@
 module Saddle
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

data/saddle.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.email         = 'mike@cleverkoala.com'
   s.description   = %q{Makes writing API clients as easy as giving high fives}
   s.summary       = %q{
-    A generic client wrapper for building service-specific wrappers. Base functionality, meant to be extended to concrete implementations.
+    A full-featured, generic consumer layer for you to build API client implementations with.
   }
   s.homepage      = 'https://github.com/mLewisLogic/saddle'
   s.license       = 'MIT'
@@ -23,6 +23,6 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
 
   s.add_dependency 'activesupport', '>= 3.0'
-  s.add_dependency 'faraday', '~> 0.8.6'
+  s.add_dependency 'faraday', '~> 0.8.7'
   s.add_dependency 'faraday_middleware', '~> 0.9.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saddle
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Mike Lewis
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: 0.8.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +108,8 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: A generic client wrapper for building service-specific wrappers. Base functionality,
-  meant to be extended to concrete implementations.
+summary: A full-featured, generic consumer layer for you to build API client implementations
+  with.
 test_files:
 - spec/requester/get_spec.rb
 - spec/requester/post_spec.rb