saddle 0.0.43 → 0.0.44

data/.gitignore

@@ -7,6 +7,7 @@
 
 # Gems
 *.gem
+Gemfile.lock
 
 # IDEs
 .idea

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 0.0.44
+* Fixed a bug where child endpoints were being attached to the parent's class. This would
+  cause problems because the root node's class is always TraversalEndpoint, and would be shared
+  amongst concrete clients.
+
+# 0.0.43
+* Fixed a bug where non-string path elements were crashing
+
+# 0.0.42
+* Fixed a bug where nil actions resulted in a trailing /
+
 # 0.0.41
 * Cleanup of the path building chain makes nicer URLs
 

data/Gemfile

@@ -1,10 +1,7 @@
 source 'https://rubygems.org'
+gemspec
 
 
-gem 'activesupport', '>= 3.0', :require => 'active_support'
-gem 'faraday', '~> 0.8.7'
-gem 'faraday_middleware', '~> 0.9.0'
-
 group :test do
   gem 'rake'
   gem 'rspec', '~> 2.14.1'

data/bin/saddle

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+require 'erb'
+require 'ostruct'
+
+require 'active_support/core_ext/string'
+
+
+# Creation options
+# TODO: read via CLI
+settings = {
+  service_name: 'Example',
+  author_name: 'Mike Lewis',
+  author_email: 'mike.lewis@airbnb.com',
+  github_account: 'airbnb',
+}
+
+
+# This holds the project settings and realizes templates
+class ProjectGenerator
+  attr_reader :settings
+
+  # Expected settings:
+  #   service_name
+  #   author_name
+  #   author_email
+  #   github_account
+  def initialize(settings)
+    settings[:project_name] = "#{settings[:service_name].underscore}-client"
+    settings[:root_module] = settings[:service_name].split('_').map(&:capitalize).join('')
+    settings[:saddle_version] = Saddle::VERSION
+    @settings = OpenStruct.new(settings)
+
+    @template_dir = File.join(File.dirname(__FILE__), 'template')
+    @output_dir = '.'
+  end
+
+  # Transform a template file into the output directory
+  def transform_template(in_file, out_file=nil)
+    out_file = in_file if out_file.nil?
+    puts "Processing: #{out_file}"
+
+    # Ensure the directory is there
+    FileUtils.mkdir_p(File.dirname(out_file))
+    # Write the processed template
+    #puts File.read(File.join(@template_dir, in_file), 'r')
+    File.open(File.join(@output_dir, out_file), 'w') do |output|
+      output.puts(
+        ERB.new(
+          File.read(File.join(@template_dir, in_file))
+        ).result(
+          @settings.instance_eval { binding }
+        )
+      )
+    end
+  end
+end
+
+pg = ProjectGenerator.new(settings)
+# /lib
+# Create the contents of the gem directory in the correctly named directory
+%w(
+  endpoints/status.rb
+  middleware/exception_raiser.rb
+  exceptions.rb
+  stub.rb
+  version.rb
+).each do |tmpl|
+  pg.transform_template("lib/saddle-client/#{tmpl}", "lib/#{pg.settings.project_name}/#{tmpl}")
+end
+pg.transform_template('lib/saddle-client.rb', "lib/#{pg.settings.project_name}.rb")
+# /spec
+pg.transform_template('spec/integration/status_spec.rb')
+pg.transform_template('spec/middleware/exception_raiser_spec.rb')
+pg.transform_template('spec/stub/stub_spec.rb')
+pg.transform_template('spec/spec_helper.rb')
+# /
+pg.transform_template('.gitignore')
+pg.transform_template('.rspec')
+pg.transform_template('Gemfile')
+pg.transform_template('LICENSE')
+pg.transform_template('README.md')
+pg.transform_template('saddle-client.gemspec', "#{pg.settings.project_name}.gemspec")

data/bin/template/.gitignore

@@ -0,0 +1,20 @@
+# Ignore temporary files
+*.sw[op]
+.DS_Store
+*.log
+*tmp
+*~
+*#
+
+# RVM
+.rvmrc
+
+# Don't lock to specific dependencies. Design for incorporation into other projects.
+Gemfile.lock
+
+# Gems
+*.gem
+
+# IDEs
+.idea
+.project

data/bin/template/.rspec

@@ -0,0 +1,4 @@
+--color
+--backtrace
+--require rspec/instafail
+--format RSpec::Instafail

data/bin/template/Gemfile

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+
+source 'https://rubygems.org'
+gemspec
+
+
+group :test do
+  gem 'rspec', '~> 2.14.1'
+  gem 'rspec-instafail', '~> 0.2'
+end
+
+group :development, :test do
+  gem 'pry'
+end

data/bin/template/LICENSE

@@ -0,0 +1,19 @@
+(c) <%= Time.now.year %>, <%= author_name %>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/bin/template/README.md

@@ -0,0 +1,27 @@
+# <%= service_name %> client
+
+
+## Usage
+```ruby
+client = <%= root_module %>::Client.create()
+service_status = client.status.healthy?
+```
+
+
+## Testing
+
+### this project
+* bundle exec rspec
+
+### from an including project
+In your spec_helper.rb, include the following snippet.
+```ruby
+<%= root_module %>::Client.stub!
+```
+This will prevent `<%= project_name %>` from reaching out to live servers.
+Instead, endpoints will return back [local stubbed data](lib/<%= project_name %>/stub.rb).
+
+
+## License
+(c) <%= Time.now.year %>, <%= author_name %>
+Released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/bin/template/lib/saddle-client.rb

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+require 'saddle'
+
+require '<%= project_name %>/exceptions'
+require '<%= project_name %>/middleware/exception_raiser'
+require '<%= project_name %>/stub'
+require '<%= project_name %>/version'
+
+
+
+module <%= root_module %>
+
+  class Client < Saddle::Client
+    extend <%= root_module %>::Stub
+
+
+    # Place default client options here
+    # Saddle supports many more options than are listed below. See the documentation.
+    #def self.host
+    #  'example.org'
+    #end
+
+    #def self.use_ssl
+    #  true
+    #end
+
+    #def self.num_retries
+    #  1
+    #end
+
+    #def self.timeout
+    #  5 # seconds
+    #end
+
+    # Raise exceptions, based upon request responses
+    add_middleware({
+      :klass => Middleware::ExceptionRaiser,
+    })
+
+  end
+
+end

data/bin/template/lib/saddle-client/endpoints/status.rb

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+require 'saddle/endpoint'
+
+module <%= root_module %>
+  module Endpoints
+
+    class Status < Saddle::TraversalEndpoint
+
+      ABSOLUTE_PATH = ''
+
+      def healthy?
+        get('health') == 'OK'
+      end
+
+    end
+
+  end
+end

data/bin/template/lib/saddle-client/exceptions.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+##
+# Exceptions for using the <%= service_name %> client
+# It is recommended that you handle these.
+##
+
+module <%= root_module %>
+
+  class GenericException < StandardError; end
+
+  class TimeoutError < GenericException; end
+
+  # Some problems might take care of themselves if you try again later. Others won't.
+  class TemporaryError < GenericException; end # fire warnings on these
+  class PermanentError < GenericException; end # fire errors on these
+
+  # Implement derivative exception classes here that represent specific errors that the
+  # service can throw via status codes or response body
+
+end

data/bin/template/lib/saddle-client/middleware/exception_raiser.rb

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+require 'faraday'
+
+require '<%= project_name %>/exceptions'
+
+
+
+module <%= root_module %>
+  module Middleware
+
+    ## Raise beautiful exceptions
+    #
+    class ExceptionRaiser < Faraday::Middleware
+
+      ## For handling errors, the message that gets returned is of the following format:
+      # {:status => env[:status], :headers => env[:response_headers], :body => env[:body]}
+
+      def call(env)
+        begin
+          @app.call(env)
+        rescue Faraday::Error::ClientError => e
+          # This is our chance to reinterpret the response into a meaningful, client-specific
+          # exception that a consuming service can handle
+          exception = <%= root_module %>::GenericException
+
+          raise exception, e.response
+        rescue Saddle::TimeoutError => e
+          raise <%= root_module %>::TimeoutError, e.response
+        end
+      end
+
+    end
+
+  end
+end

data/bin/template/lib/saddle-client/stub.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+require '<%= project_name %>/endpoints/status'
+
+# This allows us to stub out live calls when testing from calling projects
+
+module <%= root_module %>
+  module Stub
+
+    # Setup stubbing for all endpoints
+    def stub!
+      <%= root_module %>::Endpoints::Status.any_instance.stub(:healthy?).and_return(
+        Stub::Data::TEST_STATUS_HEALTHY_RESPONSE
+      )
+    end
+
+    # Test data for stubs to return
+    module Data
+
+      TEST_STATUS_HEALTHY_RESPONSE = 'OK'.freeze
+
+    end
+
+  end
+end

data/bin/template/lib/saddle-client/version.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+
+module <%= root_module %>
+  VERSION = '0.0.0'
+end

data/bin/template/saddle-client.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/<%= project_name %>/version', __FILE__)
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = '<%= project_name %>'
+  s.version       = ::<%= root_module %>::VERSION
+  s.authors       = ['<%= author_name %>']
+  s.email         = ['<%= author_email %>']
+  s.description   = %q{<%= service_name %> client}
+  s.summary       = %q{
+    This is a <%= service_name %> client implemented on Saddle
+  }
+  s.homepage      = 'https://github.com/<%= github_account %>/<%= project_name %>'
+  s.license       = 'MIT'
+
+  s.require_path  = 'lib'
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_dependency 'saddle', '~> <%= saddle_version %>'
+end

data/bin/template/spec/integration/status_spec.rb

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+
+###
+# NOTE: This spec will actually hit live servers
+###
+
+describe '<%= root_module %>::Endpoints::User' do
+  context "Test integration of status endpoints" do
+
+    let(:client) { <%= root_module %>::Client.create() }
+
+    it 'should get self profile' do
+      client.status.healthy?.should be_true
+    end
+
+  end
+end

data/bin/template/spec/middleware/exception_raiser_spec.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+
+describe <%= root_module %>::Middleware::ExceptionRaiser do
+
+  describe "Test raising various exceptions using stubs" do
+
+    let(:stubs)  { Faraday::Adapter::Test::Stubs.new }
+    let(:client) { <%= root_module %>::Client.create(:stubs => stubs) }
+
+
+    it 'should detect a service error' do
+      stubs.get('/') { [ 500, {}, { 'status' => 'error' } ] }
+      expect { client.requester.get('') }.to raise_error(<%= root_module %>::GenericException)
+    end
+
+  end
+
+end

data/bin/template/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# -*- encoding: utf-8 -*-
+
+require '<%= project_name %>'

data/bin/template/spec/stub/stub_spec.rb

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+
+
+describe <%= root_module %>::Stub do
+  context 'stubbing out calls' do
+
+    let(:client) { <%= root_module %>::Client.create }
+
+    before :each do
+      <%= root_module %>::Client.stub!
+    end
+
+    describe 'returns test data' do
+      it 'for client.status.healthy?' do
+        client.status.healthy?.should be_true
+      end
+    end
+
+  end
+end

data/lib/saddle/endpoint.rb

@@ -68,7 +68,7 @@ module Saddle
       # Attach the endpoint as an instance variable and method
       method_name ||= endpoint_class.name.demodulize.underscore
       self.instance_variable_set("@#{method_name}", endpoint_instance)
-      self.class.class_eval { define_method(method_name) { endpoint_instance } }
+      self.define_singleton_method(method_name.to_s) { endpoint_instance }
       endpoint_instance
     end
 
@@ -132,6 +132,9 @@ module Saddle
   # traversal tree.
   class TraversalEndpoint < BaseEndpoint; end
 
+  # This is a special case endpoint for the root node.
+  class RootEndpoint < TraversalEndpoint; end
+
 
   # This endpoint is used for constructing resource-style endpoints. This
   # means it will NOT be automatically added into the traversal tree.

data/lib/saddle/method_tree_builder.rb

@@ -44,11 +44,11 @@ module Saddle
           root_node_class = self.implementation_module::RootEndpoint
         else
           # 'root_endpoint.rb' doesn't exist, so create a dummy endpoint
-          root_node_class = Saddle::TraversalEndpoint
+          root_node_class = Saddle::RootEndpoint
         end
       else
         # we don't even have an implementation root, so create a dummy endpoint
-        root_node_class = Saddle::TraversalEndpoint
+        root_node_class = Saddle::RootEndpoint
       end
       root_node_class.new(requester, nil, self)
     end

data/lib/saddle/version.rb

@@ -1,3 +1,3 @@
 module Saddle
-  VERSION = '0.0.43'
+  VERSION = '0.0.44'
 end

data/saddle.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |s|
 
   s.require_path  = 'lib'
   s.files         = `git ls-files`.split($\)
-  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.executables   = ['saddle']
+  s.test_files    = s.files.grep(%r{^(spec)/})
 
   s.add_dependency 'activesupport', '>= 3.0'
   s.add_dependency 'faraday', '~> 0.8.7'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saddle
 version: !ruby/object:Gem::Version
-  version: 0.0.43
+  version: 0.0.44
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2013-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -61,7 +61,8 @@ dependencies:
         version: 0.9.0
 description: Makes writing API clients as easy as giving high fives
 email: mike.lewis@airbnb.com
-executables: []
+executables:
+- saddle
 extensions: []
 extra_rdoc_files: []
 files:
@@ -70,9 +71,25 @@ files:
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
+- bin/saddle
+- bin/template/.gitignore
+- bin/template/.rspec
+- bin/template/Gemfile
+- bin/template/LICENSE
+- bin/template/README.md
+- bin/template/lib/saddle-client.rb
+- bin/template/lib/saddle-client/endpoints/status.rb
+- bin/template/lib/saddle-client/exceptions.rb
+- bin/template/lib/saddle-client/middleware/exception_raiser.rb
+- bin/template/lib/saddle-client/stub.rb
+- bin/template/lib/saddle-client/version.rb
+- bin/template/saddle-client.gemspec
+- bin/template/spec/integration/status_spec.rb
+- bin/template/spec/middleware/exception_raiser_spec.rb
+- bin/template/spec/spec_helper.rb
+- bin/template/spec/stub/stub_spec.rb
 - lib/saddle.rb
 - lib/saddle/client_attributes.rb
 - lib/saddle/endpoint.rb

data/Gemfile.lock

@@ -1,54 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
-      multi_json (~> 1.0)
-    airbrake (3.1.12)
-      activesupport
-      builder
-      json
-    builder (3.2.0)
-    coderay (1.0.9)
-    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)
-    json (1.7.7)
-    method_source (0.8.1)
-    multi_json (1.7.3)
-    multipart-post (1.2.0)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rake (10.1.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.2)
-    rspec-expectations (2.14.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-instafail (0.2.4)
-    rspec-mocks (2.14.1)
-    simple_oauth (0.2.0)
-    slop (3.4.5)
-    statsd-ruby (1.2.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (>= 3.0)
-  airbrake
-  faraday (~> 0.8.7)
-  faraday_middleware (~> 0.9.0)
-  pry
-  rake
-  rspec (~> 2.14.1)
-  rspec-instafail (~> 0.2)
-  simple_oauth (~> 0.2.0)
-  statsd-ruby