shutl_rails 0.8.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+pkg
+
+
+Gemfile.lock

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p125

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Burns
+
+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,63 @@
+# Shutl::Rails
+
+## Summary
+
+A convenience gem for interacting with the Shutl API from a Rails application.
+Provides a JSON API within your application as a proxy to the Shutl API
+whilst handling OAuth token validation transparently.
+
+## Installation
+
+Add this line to your application's Gemfile:
+    gem 'shutl_rails'
+
+And then execute:
+    $ bundle
+
+## Usage
+
+```
+#Credentials setup
+#config/initializers/shutl.rb
+Shutl::Auth.config do |c|
+  c.client_id     = "<CLIENT_ID>"
+  c.client_secret = "<CLIENT_SECRET>"
+  c.url           = "http://shutl-api-url-goes-here"
+end
+
+
+#app/controllers/quote_collections_controller.rb
+class QuoteCollectionsController < Shutl::Rails::BackendResourcesController
+end
+
+#config/routes
+resources :quote_collections, only: [:create, :show]
+```
+
+#Converters
+In order to convert attributes from the API into ones that may want to be used
+by your application you can add any files in /app/converters and they are
+autoloaded based on the name of the Shutl resource
+
+#/app/converters/quote_collection_converter.rb
+module QuoteCollectionConverter
+  extend Shutl::Resource::Converter
+
+  convert :enabled,
+    with: BooleanConverter,
+    only: :to_back_end
+end
+
+#/app/converters/boolean_converter.rb
+module BooleanConverter
+  extend self
+
+  def to_front_end b; b           end
+  def to_back_end  b; b == 'true' end
+end
+
+```
+
+## Contributing
+
+The usual: fork, branch, commit, pull request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/shutl/rails/backend_resources_controller.rb

@@ -0,0 +1,148 @@
+module Shutl::Rails
+  class BackendResourcesController < ApplicationController
+    include Shutl::Auth::AuthenticatedRequest
+
+    respond_to :json
+    before_filter :request_access_token
+    before_filter :load_resource, only: [:show]
+
+    rescue_from Shutl::Resource::Error do |e|
+      case e.response.content_type
+      when "text/html"
+        response_hash = { debug_info: e.response.body.to_json}
+
+      when "application/json"
+        begin
+          response_hash = e.response.parsed_response
+        rescue
+          debug_info = ["Failed to parse JSON response from quote service:",
+            e.message, e.class, e.backtrace, e.response.body].join("\n\n")
+
+          response_hash = { debug_info: debug_info}
+        end
+      end
+
+      render status: e.response.code, json: response_hash
+    end
+
+    def index
+      authenticated_request do
+        instance_variable_set(
+          pluralized_instance_variable_name,
+          resource_klass.all(id_params.merge auth: access_token))
+      end
+
+      response_collection = pluralized_instance_variable.map do |o|
+        attributes_to_front_end o.attributes
+      end
+
+      render json: response_collection
+    end
+
+    def new
+      self.instance_variable= resource_klass.new
+      respond_with_json
+    end
+
+    def create
+      authenticated_request do
+        self.instance_variable= resource_klass.create id_params.merge(attributes_from_params), auth: access_token
+      end
+
+      render status: instance_variable.status, json: instance_variable.parsed
+    end
+
+    def show
+      respond_with_json
+    end
+
+    def update
+      authenticated_request do
+        resource_klass.update id_params.merge(attributes_from_params), auth: access_token
+      end
+
+      render nothing: true, status: 204
+    end
+
+    def destroy
+      authenticated_request do
+        resource_klass.destroy(id_params.merge(id: params[:id]), auth: access_token)
+      end
+
+      render nothing: true, status: 204
+    end
+
+    private
+
+    def id_params
+      params.dup.keep_if do |k, v|
+        k == 'id' or k =~ /_id\Z/
+      end
+    end
+
+    # Respond_with does not work in this case
+    def respond_with_json(status=200)
+      render status: status, json: attributes_to_front_end(instance_variable.attributes)
+    end
+
+    def load_resource
+      authenticated_request do
+        self.instance_variable = resource_klass.find(id_params, auth: access_token)
+      end
+
+      render nothing: true, status: 404 if instance_variable.nil?
+    end
+
+    def resource_klass
+      resource_klass_name.constantize
+    end
+
+    def instance_variable
+      instance_variable_get instance_variable_name
+    end
+
+    def instance_variable= value
+      instance_variable_set instance_variable_name, value
+    end
+
+    def pluralized_instance_variable
+      instance_variable_get pluralized_instance_variable_name
+    end
+
+    def pluralized_instance_variable= value
+      instance_variable_set pluralized_instance_variable_name, value
+    end
+
+    def pluralized_instance_variable_name
+      :"@#{pluralized_resource_name}"
+    end
+
+    def pluralized_resource_name
+      singular_resource_name.pluralize
+    end
+
+    def instance_variable_name
+      :"@#{singular_resource_name}"
+    end
+
+    def singular_resource_name
+      resource_klass_name.underscore
+    end
+
+    def resource_klass_name
+      self.class.to_s.gsub(/Controller/,"").singularize
+    end
+
+    def attributes_from_params
+      @attributes ||= converter_class.to_back_end params[singular_resource_name]
+    end
+
+    def converter_class
+      Shutl::Rails::Converter.class_for resource_klass
+    end
+
+    def attributes_to_front_end attrs
+      converter_class.to_front_end attrs
+    end
+  end
+end

data/lib/shutl/rails/converter.rb

@@ -0,0 +1,42 @@
+module Shutl::Rails::Converter
+  def convert *attr_names, options
+    @converters ||= {}
+
+    attr_names.map(&:to_sym).each do |attr_name|
+      @converters[attr_name] = {
+        converter_classes: Array(options[:with]),
+        methods: Array(options[:only] || [:to_back_end, :to_front_end])
+      }
+    end
+  end
+
+  %w(to_front_end to_back_end).each do |conversion|
+    define_method conversion do |attrs|
+      attrs = attrs.dup.with_indifferent_access
+      @converters.each do |attr_name, o|
+        if o[:methods].include?(conversion.to_sym)
+          attrs = convert_attribute(
+            attr_name, conversion, o[:converter_classes], attrs)
+        end
+      end
+      attrs
+    end
+  end
+
+  def convert_attribute attr_name, method, converter_classes, attrs
+    converter_classes.each do |converter_class|
+      if attrs.has_key?(attr_name)
+        attrs[attr_name] = converter_class.send(method, attrs[attr_name])
+      end
+    end
+    attrs
+  end
+
+  def self.class_for resource_class
+    begin
+      "#{resource_class}Converter".constantize
+    rescue NameError => e
+      Shutl::Rails::NoConverter
+    end
+  end
+end

data/lib/shutl/rails/engine.rb

@@ -0,0 +1,2 @@
+class Shutl::Rails::Engine < Rails::Engine
+end

data/lib/shutl/rails/no_converter.rb

@@ -0,0 +1,6 @@
+module Shutl::Rails::NoConverter
+  extend self
+
+  def to_front_end value; value end
+  def to_back_end  value; value end
+end

data/lib/shutl/rails/version.rb

@@ -0,0 +1,5 @@
+module Shutl
+  module Rails
+    VERSION = "0.8.0"
+  end
+end

data/lib/shutl_rails.rb

@@ -0,0 +1,7 @@
+require "shutl/rails/version"
+
+require 'shutl_resource'
+
+require "shutl/rails/converter"
+require "shutl/rails/no_converter"
+require "shutl/rails/engine"

data/shutl_rails.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shutl/rails/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "shutl_rails"
+  gem.version       = Shutl::Rails::VERSION
+  gem.authors       = ["Mark Burns"]
+  gem.email         = ["markthedeveloper@gmail.com"]
+  gem.description   = %q{A gem for using shutl_resources easily in a Rails app}
+  gem.summary       = %q{Methods for easily authenticating with OAuth2 and interacting with shutl resources }
+  gem.homepage      = ""
+
+  gem.add_dependency 'shutl_resource', '~> 0.8.0'
+
+  gem.add_dependency 'rails', '~> 3.2.11'
+
+  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'debugger'
+  gem.add_development_dependency 'webmock', '~> 1.8.7'
+
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/controllers/access_token_management_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'action_controller'
+require 'rails'
+require 'shutl_rails'
+
+class ApplicationController < ActionController::Base
+  include Shutl::Auth::AuthenticatedRequest
+end
+
+describe ApplicationController do
+  before { session[:access_token] = token_in_session }
+
+  describe '#request_access_token' do
+
+    context 'token in session' do
+      let(:token_in_session) { 'token' }
+
+      it "doesn't do anything" do
+        subject.request_access_token
+      end
+    end
+
+    context 'no token in session' do
+      let(:token_in_session) { nil }
+
+      let(:access_token_request) do
+        mock 'access token request', access_token!: access_token_response
+      end
+
+      let(:access_token_response) do
+        mock 'access token response', access_token: 'token from auth service'
+      end
+
+      before do
+        Shutl::Auth::AccessTokenRequest.should_receive(:new).
+          and_return access_token_request
+      end
+
+      it "gets token from auth service and saves it in session" do
+        subject.access_token
+
+        session[:access_token].should == 'token from auth service'
+      end
+    end
+  end
+
+  describe '#authenticated_request' do
+    let(:token_in_session) { 'token from session' }
+
+    context 'request successful' do
+      it 'just runs it once' do
+        v = 'block not called'
+        subject.authenticated_request do
+          v = 'block called'
+        end
+
+        v.should == 'block called'
+      end
+    end
+
+    context 'request unauthorized' do
+      let(:access_token_request) do
+        mock 'access token request', access_token!: access_token_response
+      end
+
+      let(:access_token_response) do
+        mock 'access token response', access_token: 'token from auth service'
+      end
+
+      let(:responses) do
+        [
+          -> { 'success' },
+          -> { raise Shutl::UnauthorizedAccess.new 'message', 'response' }
+        ]
+      end
+
+      before do
+        Shutl::Auth::AccessTokenRequest.should_receive(:new).
+          and_return access_token_request
+      end
+
+      it 'gets new token from auth service and stores it in the session' do
+        subject.authenticated_request do
+          responses.pop.call
+        end
+
+        session[:access_token].should == 'token from auth service'
+      end
+
+      it 'calls the block second time' do
+        v = nil
+        subject.authenticated_request do
+          v = responses.pop.call
+        end
+        v.should == 'success'
+      end
+    end
+  end
+end

data/spec/rails_app.rb

@@ -0,0 +1,4 @@
+#require File.expand_path('../boot', __FILE__)
+require 'rails/all'
+class WithoutThisWeCantTestControllersWithRSpecNotSureWhyYet < Rails::Application
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+#require File.expand_path("../../config/environment", __FILE__)
+require './spec/rails_app'
+require 'active_model'
+require 'rspec/rails'
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  # 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

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: shutl_rails
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+  prerelease: 
+platform: ruby
+authors:
+- Mark Burns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shutl_resource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+description: A gem for using shutl_resources easily in a Rails app
+email:
+- markthedeveloper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/shutl/rails/backend_resources_controller.rb
+- lib/shutl/rails/converter.rb
+- lib/shutl/rails/engine.rb
+- lib/shutl/rails/no_converter.rb
+- lib/shutl/rails/version.rb
+- lib/shutl_rails.rb
+- shutl_rails.gemspec
+- spec/controllers/access_token_management_spec.rb
+- spec/rails_app.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1862001743972581603
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1862001743972581603
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Methods for easily authenticating with OAuth2 and interacting with shutl
+  resources
+test_files:
+- spec/controllers/access_token_management_spec.rb
+- spec/rails_app.rb
+- spec/spec_helper.rb