actionback 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 848b3198c4623ac5a1b7d75f957af2e1c8c021a7
+  data.tar.gz: 6744b31b2d4d21f351aba3c2920c1abd9f833bd2
+SHA512:
+  metadata.gz: eec5b6b825cb1ba829d5cde32ccd9e48241dbf9dc924cba5fea8374f4368e1091f79e3090bb7be53d4b1ccd0b18b3fcfb87c4959488e9a62450b13288ace4620
+  data.tar.gz: c35a63213f5f2334e37d6edc114aae455b829b40285c8a2a8653fe27f37180fbc68c2b7989a96e5d50c858f2eb1db330c4a9b8ffee285182efdc97044468a8db

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,93 @@
+actionback
+==========
+[![Build Status](https://travis-ci.org/sweatshirtio/actionback.svg?branch=master)](https://travis-ci.org/sweatshirtio/actionback)
+
+`Action Pack` can now go **BACK!**
+
+Deserialize URLs to resources or resource IDs.  Action Back uses your defined routes and controllers to determine the correct resource to return.  This is great for `Hypermedia APIs` and following [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS) principles in your REST APIs.
+
+Put more simply, actionback will turn
+`http://api.yourapp.com/users/3` into `#<User id:3, first_name: "Bob">`.
+
+## Installation
+Add `actionback` to your Gemfile:
+```ruby
+gem 'actionback'
+```
+
+## Supported Ruby/Rails versions
+- ruby >= 1.9.3
+- rails >= 3.0
+
+## Deserializing URLs to Resources
+
+### Serializers
+Include `ActionBack::RouteBack` in your serializer (or wherever you may want to deserialize URLs to resources).  This will give the serializer the ability to `find` a resource given a `URL`.  Behind the scenes, `ActionBack::RouteBack` is calling on the inferred controller to return the correct resource.
+
+
+Here is an example of using actionback with [Roar-Rails](https://github.com/apotonick/roar-rails)
+```ruby
+# Represent user
+class UserRepresenter < Representable::Decorator
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+  include ActionBack::RouteBack
+
+  property :name
+end
+
+
+# Represent awesomeness
+class AwesomeRepresenter < Representable::Decorator
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+
+  # Deserialize the passed in user URL to a user instance
+  property :user,
+    decorator: UserRepresenter,
+    instance: lambda { |fragment, *args| fragment },
+    deserialize: lambda { |object, fragment, *args| object.resource_from_url(fragment) }
+end
+```
+
+The above example expects a URL, such as `http://api.awesomeapp.com/users/3`,
+to be passed in as the value for the user property.  `AwesomeRepresenter` will then call on `ActionBack` with this URL for the correct User resource.
+
+`#<User id:3 >` will now officially be related to **Awesome**! You're happy because that couldn't have been easier.  `#<User id:3 >` is happy because he/she is now awesome :satisfied:.  Hooray... Everyones happy :+1:
+
+#### ActionBack::RouteBack Methods
+- `#resource_from_url(url):` returns ActiveRecord model instantce
+
+- `#id_from_url(url):`       returns ActiveRecord model ID
+
+### Controllers
+`ActionBack::ControllerAdditions` adds class methods to your controller to give it the ability to return a resource/resource ID given route params.
+
+Controllers are inferred in actionback via rails routes.  They are called on to return the classified resource or resource ID.  You will need to include `ActionBack::ControllerAdditions` in the relevant controllers.
+
+```ruby
+class AwesomeController < ApplicationController
+  include ActionBack::ControllerAdditions
+end
+```
+
+## Custom Behavior
+### Controllers
+It is more likely that you will want to override `ActionBack::Controller` methods.
+
+By overriding the controller methods, you can create your own complex queries to fetch resources.  You will want to do this for queries that involve more than one ID, such as for nested routes.
+
+For example:
+```ruby
+class GroupUsersController < ApplicationController
+  include ActionBack::ControllerAdditions
+
+  def self.fetch_resource(route_params)
+    User.where id: route_params[:id], group_id: route_params[:group_id]
+  end
+
+  def self.fetch_resource_id(route_params)
+    { id: route_params[:id], group_id: route_params[:group_id] }
+  end
+end
+```

data/lib/actionback.rb

@@ -0,0 +1,8 @@
+require 'actionback/acronym'
+
+module ActionBack
+  extend ActiveSupport::Autoload
+
+  autoload :ControllerAdditions
+  autoload :RouteBack
+end

data/lib/actionback/acronym.rb

@@ -0,0 +1,5 @@
+require 'active_support/inflector'
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.acronym 'ActionBack'
+end

data/lib/actionback/controller_additions.rb

@@ -0,0 +1,16 @@
+module ActionBack
+  module ControllerAdditions
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def fetch_resource_id(route_params)
+        route_params[:id]
+      end
+
+      def fetch_resource(route_params)
+        resource_id = fetch_resource_id route_params
+        controller_name.classify.constantize.find resource_id
+      end
+    end
+  end
+end

data/lib/actionback/route_back.rb

@@ -0,0 +1,24 @@
+module ActionBack
+  module RouteBack
+    def match_path(path)
+      Rails.application.routes.recognize_path path
+    end
+
+    def infer_controller(route_params)
+      # OPTIMIZE possible to do without instantiating new instance?
+      ActionDispatch::Routing::RouteSet::Dispatcher.new.controller route_params
+    end
+
+    def id_from_url(url)
+      match = match_path url
+
+      infer_controller(match).fetch_resource_id match
+    end
+
+    def resource_from_url(url)
+      match = match_path url
+
+      infer_controller(match).fetch_resource match
+    end
+  end
+end

data/lib/actionback/version.rb

@@ -0,0 +1,3 @@
+module ActionBack
+  VERSION = "0.0.1"
+end

data/lib/tasks/actionback_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :actionback do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: actionback
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ari Summer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Deserialize URLs to resources or resource IDs. Great for Hypermedia APIs.
+email:
+- aribsummer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/actionback.rb
+- lib/actionback/acronym.rb
+- lib/actionback/controller_additions.rb
+- lib/actionback/route_back.rb
+- lib/actionback/version.rb
+- lib/tasks/actionback_tasks.rake
+homepage: https://github.com/sweatshirtio/actionback
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: actionpack with back
+test_files: []