trax_controller 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 073eda93c53968cf904385eae5a197bc0f32163a
+  data.tar.gz: e3e923554c0072ee104eb984590706b103459850
+SHA512:
+  metadata.gz: 81311299663e3952883c591f091e96fd749058088db5afc30fa3878f58c9778552eadbe6cb303c5b6c675e9553c44e8b00414b15e911b2932713651f2cbf964e
+  data.tar.gz: 46174f18c3e3f0bb6e9d648fb6443122e3a13b619ad7c6f2ee73c9e42e3fd97a3b8477400338e79394e0a989f2378c4ae95c4cbd51df338940cc300480028f37

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jason Ayre
+
+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,54 @@
+# TraxController
+
+Resourceful more standardized controllers. Uses inherited resources. Geared towards api driven apps.
+
+### Standards
+
+More soon.
+
+
+
+``` ruby
+class Admin::Api::WidgetsController < ::Admin::Api::BaseController
+  include ::Trax::Controller
+
+  defaults :resource_class => ::Widget
+
+  def resource_serializer
+    ::Admin::Api::WidgetSerializer
+  end
+
+  #normally same as above unless overridden
+  def collection_serializer
+    ::Admin::Api::WidgetSerializer
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trax_controller'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trax_controller
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/trax_controller/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/trax/controller/actions.rb

@@ -0,0 +1,89 @@
+module Trax
+  module Controller
+    module Actions
+      extend ::ActiveSupport::Concern
+
+      included do
+        respond_to :json
+      end
+
+      def index
+        render :json => collection,
+        :meta => collection_response_meta,
+        :each_serializer => collection_serializer,
+        :root => collection_root
+      end
+
+      def create
+        create! do |success, failure|
+          success.json do
+            render_resource(201)
+          end
+
+          failure.json do
+            render_errors(:unprocessable_entity, *resource.errors.full_messages)
+          end
+        end
+      end
+
+      def update
+        update! do |success, failure|
+          success.json do
+            render_resource
+          end
+
+          failure.json do
+            render_errors(:unprocessable_entity, *resource.errors.full_messages)
+          end
+        end
+      end
+
+      def destroy
+        destroy! do |success, failure|
+          success.json do
+            render_resource
+          end
+
+          failure.json do
+            render_errors(:method_not_allowed, *resource_response_meta[:errors])
+          end
+        end
+      end
+
+      def show
+        render_resource
+      end
+
+      private
+
+      def render_resource(status = :ok)
+        render json: resource, serializer: resource_serializer, meta: resource_response_meta, status: status, scope: serialization_scope
+      end
+
+      def render_errors(status, *errors)
+        errors = errors.map { |str| str.last == "." ? str : str << "." }
+        render json: { meta: { errors: errors } }, status: status, serializer: nil
+      end
+
+      def collection_serializer
+        resource_serializer
+      end
+
+      def resource_serializer
+        "#{resource_class.name.demodulize}Serializer".constantize
+      end
+
+      def collection_root
+        controller_name
+      end
+
+      def resource_root
+        collection_root.singularize
+      end
+
+      def serialized_resource
+        @serialized_resource ||= resource_serializer.new(resource, scope: serialization_scope)
+      end
+    end
+  end
+end

data/lib/trax/controller/collection/base.rb

@@ -0,0 +1,22 @@
+module Trax
+  module Controller
+    module Collection
+      module Base
+        extend ::ActiveSupport::Concern
+        
+        included do
+          class_attribute :collection_options
+          self.collection_options = ::ActiveSupport::OrderedOptions.new
+        end
+
+        module ClassMethods
+          def collection_defaults(options = {})
+            collection_options.merge!(options)
+          end
+        end
+
+        include ::Trax::Controller::Collection::ResponseMeta
+      end
+    end
+  end
+end

data/lib/trax/controller/collection/response_meta.rb

@@ -0,0 +1,19 @@
+module Trax
+  module Controller
+    module Collection
+      module ResponseMeta
+        extend ::ActiveSupport::Concern
+
+        included do
+          helper_method :collection_response_meta
+        end
+
+        def collection_response_meta
+          @collection_response_meta ||= {
+            :json_root => collection_root
+          }
+        end
+      end
+    end
+  end
+end

data/lib/trax/controller/collection/searchable.rb

@@ -0,0 +1,27 @@
+module Trax
+  module Controller
+    module Collection
+      module Searchable
+        extend ::ActiveSupport::Concern
+
+        def search
+          render :json => search_collection,
+                 :meta => collection_response_meta,
+                 :each_serializer => collection_serializer,
+                 :root => collection_root
+        end
+
+        def search_collection
+          @search_collection ||= begin
+            search_keys = self.class.scopes_configuration.keys
+
+            search_keys.inject(collection.all) do |result, key|
+              relation = params.has_key?("#{key}") ? result.__send__(key, params[key]) : result
+              relation
+            end.all
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trax/controller/collection.rb

@@ -0,0 +1,11 @@
+module Trax
+  module Controller
+    module Collection
+      extend ::ActiveSupport::Autoload
+
+      autoload :Base
+      autoload :ResponseMeta
+      autoload :Searchable
+    end
+  end
+end

data/lib/trax/controller/inherit_resources.rb

@@ -0,0 +1,13 @@
+module Trax
+  module Controller
+    module InheritResources
+      extend ::ActiveSupport::Concern
+
+      included do
+        ::InheritedResources::Base.inherit_resources(self)
+        initialize_resources_class_accessors!
+        create_resources_url_helpers!
+      end
+    end
+  end
+end

data/lib/trax/controller/resource/base.rb

@@ -0,0 +1,16 @@
+module Trax
+  module Controller
+    module Resource
+      module Base
+        extend ::ActiveSupport::Concern
+
+        included do
+          class_attribute :resource_options
+        end
+
+        include ::Trax::Controller::Resource::ResponseMeta
+        include ::Trax::Controller::Resource::Errors
+      end
+    end
+  end
+end

data/lib/trax/controller/resource/errors.rb

@@ -0,0 +1,21 @@
+module Trax
+  module Controller
+    module Resource
+      module Errors
+        extend ::ActiveSupport::Concern
+
+        def resource_errors?
+          resource.errors.any?
+        end
+
+        def resource_response_meta
+          if resource_action? && resource_errors?
+            super.merge!(:errors => resource.errors.messages)
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trax/controller/resource/response_meta.rb

@@ -0,0 +1,19 @@
+module Trax
+  module Controller
+    module Resource
+      module ResponseMeta
+        extend ::ActiveSupport::Concern
+
+        included do
+          helper_method :resource_response_meta
+        end
+
+        def resource_response_meta
+          @resource_response_meta ||= {
+            :json_root => resource_root
+          }
+        end
+      end
+    end
+  end
+end

data/lib/trax/controller/resource.rb

@@ -0,0 +1,11 @@
+module Trax
+  module Controller
+    module Resource
+      extend ::ActiveSupport::Autoload
+
+      autoload :Base
+      autoload :Errors
+      autoload :ResponseMeta
+    end
+  end
+end

data/lib/trax/controller.rb

@@ -0,0 +1,35 @@
+require 'hashie/dash'
+require 'hashie/mash'
+require 'trax_core'
+require 'inherited_resources'
+
+module Trax
+  module Controller
+    extend ::ActiveSupport::Concern
+    extend ::ActiveSupport::Autoload
+
+    included do
+      inherit_resources
+    end
+
+    autoload :Actions
+    autoload :Collection
+    autoload :Resource
+    autoload :InheritResources
+
+    include ::Trax::Controller::InheritResources
+    include ::Trax::Controller::Collection::Base
+    include ::Trax::Controller::Resource::Base
+    include ::Trax::Controller::Actions
+
+    # inherit_resources
+
+
+
+    # included do
+    #   inherit_resources
+    # end
+
+
+  end
+end

data/lib/trax.rb

@@ -0,0 +1,3 @@
+require 'trax/controller'
+
+module Trax; end

data/lib/trax_controller/version.rb

@@ -0,0 +1,3 @@
+module TraxController
+  VERSION = "0.0.2"
+end

data/lib/trax_controller.rb

@@ -0,0 +1,5 @@
+require_relative './trax'
+
+module TraxController
+  # Your code goes here...
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+require 'simplecov'
+require 'pry'
+require 'trax_controller'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+  end
+end
+
+Bundler.require(:default, :development, :test)
+
+::Dir["#{::File.dirname(__FILE__)}/support/*.rb"].each {|f| require f }

data/spec/trax/controller_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe ::Trax::Controller do
+  it {
+    should respond_to(:defaults)
+  }
+end

data/trax_controller.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trax_controller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trax_controller"
+  spec.version       = TraxController::VERSION
+  spec.authors       = ["Jason Ayre"]
+  spec.email         = ["jasonayre@gmail.com"]
+  spec.summary       = %q{Resourceful, standardized controllers}
+  spec.description   = %q{Resourceful, standardized controllers}
+  spec.homepage      = "http://www.github.com/jasonayre"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "trax_core"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "inherited_resources"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-pride"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency 'rspec-its', '~> 1'
+  spec.add_development_dependency 'rspec-collection_matchers', '~> 1'
+  spec.add_development_dependency 'guard', '~> 2'
+  spec.add_development_dependency 'guard-rspec', '~> 4'
+  spec.add_development_dependency 'guard-bundler', '~> 2'
+  spec.add_development_dependency 'rb-fsevent'
+  spec.add_development_dependency 'terminal-notifier-guard'
+end

metadata

@@ -0,0 +1,306 @@
+--- !ruby/object:Gem::Specification
+name: trax_controller
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jason Ayre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trax_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: inherited_resources
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec-pride
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  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'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  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: Resourceful, standardized controllers
+email:
+- jasonayre@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/trax.rb
+- lib/trax/controller.rb
+- lib/trax/controller/actions.rb
+- lib/trax/controller/collection.rb
+- lib/trax/controller/collection/base.rb
+- lib/trax/controller/collection/response_meta.rb
+- lib/trax/controller/collection/searchable.rb
+- lib/trax/controller/inherit_resources.rb
+- lib/trax/controller/resource.rb
+- lib/trax/controller/resource/base.rb
+- lib/trax/controller/resource/errors.rb
+- lib/trax/controller/resource/response_meta.rb
+- lib/trax_controller.rb
+- lib/trax_controller/version.rb
+- spec/spec_helper.rb
+- spec/trax/controller_spec.rb
+- trax_controller.gemspec
+homepage: http://www.github.com/jasonayre
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Resourceful, standardized controllers
+test_files:
+- spec/spec_helper.rb
+- spec/trax/controller_spec.rb