shutl_resource 0.8.0

data/.gitignore

@@ -0,0 +1,13 @@
+
+.rbenv-version
+
+.bundle
+
+.pkg
+
+.vendor
+
+vendor
+
+pkg
+Gemfile.lock

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p327-perf

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--drb
+--debug
+--tag ~@slow

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p362@shutl_resource"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.17.2 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+matrix:
+  allow_failures:
+    - jruby-19mode
+
+rvm:
+  - 1.9.2
+  - "1.9.3"
+  - jruby-19mode # JRuby in 1.9 mode
+jdk:
+  - openjdk7
+  - oraclejdk7
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shutl_resource.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Rouchy
+
+MIT License
+
+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/README.md

@@ -0,0 +1,61 @@
+# Shutl::Resource
+
+Yep this is ActiveResource-esque.
+
+Abstracted from our backend, but no reason to not make this public. Possibly
+useful elsewhere.
+Only slightly strange thing you may find is that we have our own HTTP status
+code (299) which corresponds to the case of no quotes generated. The jury is
+still out on this.
+
+This NoQuotesGenerated is shutl specific corresponding to HTTP status 299.
+We had a good think about what the correct HTTP code is for the case that
+the request is fine, but we couldn't generate any quotes. It doesn't feel
+like a 4xx or a 5xx, but not quite like a 2xx either. Comments/thoughts
+more than welcome.
+
+#Usage
+
+```ruby
+#app/models/shutl/quote.rb
+class Shutl::QuoteCollection
+  include Shutl::Resource::Rest
+  base_uri "http://shutl-api-url"
+end
+```
+
+
+The following exceptions may be raised
+```
+  200..399 no problem
+  299      Shutl::NoQuotesGenerated
+  400      Shutl::BadRequest
+  401      Shutl::UnauthorizedAccess
+  403      Shutl::ForbiddenAccess
+  404      Shutl::ResourceNotFound
+  409      Shutl::ResourceConflict
+  410      Shutl::ResourceGone
+  422      Shutl::ResourceInvalid
+  500      Shutl::ServiceUnavailable
+```
+
+## Installation
+
+Add this line to your rails app's Gemfile:
+
+    gem 'shutl_resource'
+
+# OAuth2
+It uses OAuth2 Bearer tokens for API calls using the shutl_auth gem
+
+e.g. the following header is attached to requests
+
+`
+Authorization: Bearer some/big/long/base64/thing/goes/here==
+`
+
+
+
+## Contributing
+
+The usual: fork, branch, commit, pull request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--color --format doc"
+end
+
+task :test => :spec
+task :default => :spec

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/erubis

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'erubis' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('erubis', 'erubis')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/httparty

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'httparty' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('httparty', 'httparty')

data/bin/httpclient

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'httpclient' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('httpclient', 'httpclient')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/rackup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rack', 'rackup')

data/bin/rails

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rails' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('railties', 'rails')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rake2thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake2thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'rake2thor')

data/bin/rdebug

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rdebug' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('debugger', 'rdebug')

data/bin/ri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rdoc', 'ri')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/sprockets

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'sprockets' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sprockets', 'sprockets')

data/bin/thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'thor')

data/bin/tilt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tilt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tilt', 'tilt')

data/bin/tt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('treetop', 'tt')

data/lib/shutl/resource/configuration.rb

@@ -0,0 +1,36 @@
+require 'logger'
+
+module Shutl::Resource
+
+  class << self
+    attr_writer :raise_exceptions_on_validation
+
+    def raise_exceptions_on_validation
+      if @raise_exceptions_on_validation.nil?
+        @raise_exceptions_on_validation = true
+      end
+
+      @raise_exceptions_on_validation
+    end
+  end
+
+  def configure(*args, &block)
+    Configuration.configure(*args, &block)
+  end
+
+  module Configuration
+    class << self
+      def logger
+        @logger ||= Logger.new($stdout)
+      end
+
+      def configure
+        yield self
+      end
+
+      def logger=(logger)
+        @logger = logger
+      end
+    end
+  end
+end

data/lib/shutl/resource/errors.rb

@@ -0,0 +1,28 @@
+class Shutl::Resource::Error < ::IOError
+  attr_reader :response
+
+  def initialize message, http_response
+    @response = http_response
+
+    super message #it really is rather spot on, why thanks for saying, kind sir.
+  end
+end
+
+# This NoQuotesGenerated is shutl specific corresponding to HTTP status 299.
+# We had a good think about what the correct HTTP code is for the case that
+# the request is fine, but we couldn't generate any quotes. It doesn't feel
+# like a 4xx or a 5xx, but not quite like a 2xx either. Comments/thoughts
+# more than welcome.
+Shutl::NoQuotesGenerated  = Class.new Shutl::Resource::Error
+
+Shutl::BadRequest         = Class.new Shutl::Resource::Error
+Shutl::UnauthorizedAccess = Class.new Shutl::Resource::Error
+Shutl::ForbiddenAccess    = Class.new Shutl::Resource::Error
+Shutl::ResourceNotFound   = Class.new Shutl::Resource::Error
+Shutl::ResourceConflict   = Class.new Shutl::Resource::Error
+Shutl::ResourceGone       = Class.new Shutl::Resource::Error
+Shutl::ResourceInvalid    = Class.new Shutl::Resource::Error
+Shutl::ServerError        = Class.new Shutl::Resource::Error
+Shutl::ServiceUnavailable = Class.new Shutl::Resource::Error
+
+

data/lib/shutl/resource/rest.rb

@@ -0,0 +1,101 @@
+require 'httparty'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/hash'
+require 'active_support/inflector'
+require 'json'
+require 'uri'
+require 'active_model'
+
+module Shutl::Resource
+  module Rest
+    extend HTTParty
+    include ActiveModel::Serialization
+
+    attr_reader :response
+
+    def self.included(base)
+      base.send :include, HTTParty
+      base.send :extend,  Shutl::Resource::RestClassMethods
+
+      base.send :headers, {
+        'Accept'        => 'application/json',
+        'Content-Type'  => 'application/json'
+      }
+
+      base.send :resource_name, base.name.split('::').last.underscore
+      base.send :resource_id,   :id
+    end
+
+    def initialize(args = {}, response=nil)
+      update_attributes args
+      @response = response
+    end
+
+    def to_json(options = nil)
+      {
+        :"#{prefix}" => attributes
+      }.to_json(options)
+    end
+
+    def update_attributes(attrs)
+      attrs.each { |a, v| instance_variable_set(:"@#{a}", v) }
+    end
+
+    def update!(attrs)
+      new_attributes = attributes.merge attrs
+      update_attributes(self.class.add_resource_id_to new_attributes)
+      save
+    end
+
+    def save options={}
+      self.class.save self, options
+    end
+
+    def destroy options
+      self.class.destroy self, options
+    end
+
+    def method_missing(method, *args, &block)
+      if self.instance_variables.include?(:"@#{method}")
+        return self.instance_variable_get(:"@#{method}")
+      end
+      super
+    end
+
+    def parsed
+      response.parsed_response
+    end
+
+    def status
+      response.code
+    end
+
+    attr_accessor :errors
+
+    def valid?
+      errors.blank?
+    end
+
+    def resource_id
+      instance_variable_get :"@#{self.class.resource_id_name}"
+    end
+
+    def attributes
+      (instance_variables - [:@response]).inject({}.with_indifferent_access) do |h, var|
+        h.merge( { var.to_s.gsub('@','').to_sym => instance_variable_get(var)})
+      end
+    end
+
+    private
+
+    def check_fail *args
+      self.class.send :check_fail, *args
+    end
+
+    protected
+
+    def prefix
+      self.class.instance_variable_get(:@resource_name)
+    end
+  end
+end