axel 0.0.1

data/app/models/axel/service_resource/routes.rb

@@ -0,0 +1,19 @@
+Axel::Router
+module Axel
+  module ServiceResource
+    module Routes
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def routes
+          @_routes ||= {}.with_indifferent_access
+        end
+
+        def route(route_path, name, options = {})
+          new_route = Router.new(self, route_path, name, options)
+          routes[new_route.method_name] = new_route.define_route
+        end
+      end
+    end
+  end
+end

data/app/models/axel/service_resource/typhoid_extensions.rb

@@ -0,0 +1,134 @@
+module Axel
+  module ServiceResource
+    module TyphoidExtensions
+      extend ActiveSupport::Concern
+
+      included do
+        extend Axel::CascadableAttribute
+        cascade_attribute :site
+        cascade_attribute :path
+        cascade_attribute :auto_init_fields
+        protected
+        attr_writer :attributes
+        attr_writer :metadata
+        attr_writer :remote_errors
+        attr_writer :result
+        attr_writer :payload
+
+        public
+        attr_reader :metadata
+        attr_reader :remote_errors
+        attr_reader :result
+        attr_reader :payload
+      end
+
+      def envelope?
+        payload.has_key?(:metadata) && payload.has_key?(:result)
+      end
+
+      def default_request_options;end
+
+      def request_and_load(&block)
+        metadata.reset!
+        remote_errors.reset!
+        super
+      end
+
+      # Makes Typhoid::Resource#success check remote_errors
+      def resource_exception
+        remote_errors.exception || super
+      end
+
+      def create_request(method = :post)
+        object_request method, to_params.to_json
+      end
+
+      def update_request(method = :put)
+        object_request method, to_params.to_json
+      end
+
+      def delete_request(method = :delete)
+        object_request method
+      end
+
+      def build_typhoid_request(options = {})
+        self.class.build_typhoid_request request_uri, options
+      end
+
+      def object_request(method, body = nil)
+        bare_options = { method: method }
+        bare_options[:body] = body if body
+        build_typhoid_request retrieve_default_request_options(bare_options)
+      end
+
+      def load_values(hash = {})
+        self.payload, self.result, self.metadata, self.remote_errors = PayloadParser.new(hash).parsed
+        merge_result
+        self
+      end
+
+      def merge_result
+        self.attributes.deep_merge! result
+      end
+
+      def after_build(response, error)
+        super
+        self.remote_errors.status = response.code
+      end
+
+      def attributes
+        @attributes ||= {}.with_indifferent_access
+      end
+
+      def retrieve_default_request_options(options)
+        RequestOptions.new(compiled_default_request_options, options).compiled
+      end
+      private :retrieve_default_request_options
+
+      def compiled_default_request_options
+        (self.class.default_request_options ||{}).merge(default_request_options || {})
+      end
+      private :compiled_default_request_options
+
+      module ClassMethods
+        def default_request_options;end
+
+        def manual_request(method, uri, request_options = {})
+          Typhoeus::Request.send method, uri, request_options
+        end
+
+        def builder
+          ::Axel::ServiceResource::Builder
+        end
+
+        def retrieve_default_request_options(options)
+          RequestOptions.new(default_request_options, options).compiled
+        end
+
+        def build_typhoid_request(request_uri = nil, options = {})
+          uri = request_uri || self.request_uri
+          Typhoid::RequestBuilder.new(self, uri, options)
+        end
+
+        # Manually register base URL, useful if the API Proxy is pointing at the
+        # wrong location or doesn't know about the location
+        def site(url = nil)
+          @site = url if url
+          resource ? (@site || resource.base_url) : @site
+        end
+
+        # Manually register a path, useful if the API Proxy is pointing at the
+        # wrong location or doesn't know about the location
+        def path(path = nil)
+          if resource
+            resource.path = path if path
+            resource.path
+          else
+            @path = path if path
+            @path || resource_name
+          end
+        end
+      end
+    end
+  end
+end

data/app/views/layouts/axel.json.jbuilder

@@ -0,0 +1,7 @@
+# MultiJson will use Oj, currently noted as being faster
+# than most other Parsers available to Ruby
+json.metadata safe_json_load metadata.to_json
+
+json.errors safe_json_load(errors.to_json) if errors.display?
+
+json.result safe_json_load yield

data/app/views/layouts/axel.xml.builder

@@ -0,0 +1,12 @@
+xml.instruct!
+xml.document do
+  xml << metadata.to_xml
+
+  xml << errors.to_xml
+
+  xml.result do
+    # Hack because rabl doesn't like having root-node-less things rendered
+    # Example: users/me.rabl renders with a <hash> wrapped around it
+    xml << xml_clean(yield)
+  end
+end

data/axel.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'axel/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "axel"
+  gem.version       = Axel::VERSION
+  gem.authors       = ["Jon Phenow"]
+  gem.email         = ["jon.phenow@sportngin.com"]
+  gem.description   = %q{Building blocks and general helpers for platform services}
+  gem.summary       = %q{Consistent controller responses, Resources for querying other services consistently, along with some general app support}
+  gem.homepage      = "http://github.com/sportngin/axel"
+
+  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"]
+
+  gem.add_development_dependency 'rake', "~> 10.0.3"
+  gem.add_development_dependency 'rspec-rails', "~> 2.14"
+  gem.add_development_dependency 'rspec-its'
+  gem.add_development_dependency 'rspec-collection_matchers'
+  gem.add_development_dependency 'pry-rails'
+  gem.add_development_dependency 'awesome_print', "~> 1.1.0"
+  gem.add_development_dependency 'sqlite3', "~> 1.3.6"
+  gem.add_development_dependency 'simplecov', "~> 0.7.1"
+
+  gem.add_development_dependency 'activerecord', '> 3.0'
+  gem.add_development_dependency 'gemfury'
+
+  gem.add_dependency 'activesupport', "> 3.0"
+  gem.add_dependency 'actionpack', "> 3.0", "< 4.2"
+  gem.add_dependency 'railties', "> 3.0"
+
+  gem.add_dependency 'rabl', "~> 0.7.9"
+  gem.add_dependency 'jbuilder', ">= 0.9.0"
+  gem.add_dependency 'oj', "~> 2.0.0"
+  gem.add_dependency 'ffi', ">= 1.0.0"
+  gem.add_dependency 'typhoid', "~> 0.0.2"
+  gem.add_dependency 'json'
+end

data/lib/axel.rb

@@ -0,0 +1,56 @@
+require 'rabl'
+require 'jbuilder'
+require 'oj'
+require 'typhoid'
+require "axel/version"
+require 'axel/controller_base'
+require "axel/inspector"
+require "axel/request_options"
+require 'axel/uri'
+require 'axel/controller_parameters'
+require 'axel/cascadable_attribute'
+require 'axel/application_extensions'
+require 'axel/configurator'
+require 'axel/payload/remote_error'
+
+module Axel
+  NotAuthorized = Class.new(StandardError)
+  ForceSSL = Class.new(StandardError)
+
+  def self.config(&block)
+    yield _config
+    _config.service_configs.each do |name, configuration|
+      unless respond_to? name
+        define_singleton_method(name) { configuration }
+      end
+    end
+  end
+
+  def self.service_configurator
+    _config.services
+  end
+
+  def self.services
+    _config.service_configs
+  end
+
+  def self.resources
+    _config.resources
+  end
+
+  def self.environment
+    _config.environment
+  end
+
+  def self.manual_environment_set?
+    _config.manual_environment_set?
+  end
+
+  def self._config
+    @config ||= Axel::Configurator.new
+  end
+end
+require 'axel/application_helper'
+require "axel/engine"
+require 'axel/controller_helpers'
+require 'axel/base_controller'

data/lib/axel/application_extensions.rb

@@ -0,0 +1,13 @@
+require 'rails/application'
+require 'active_support/concern'
+module Axel
+  module ApplicationExtensions
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def productionish?
+        !!Rails.env.match(/(production|staging)/)
+      end
+    end
+  end
+end
+Rails::Application.send :include, Axel::ApplicationExtensions

data/lib/axel/application_helper.rb

@@ -0,0 +1,27 @@
+module Axel
+  module ApplicationHelper
+    def page_title
+      result = controller_params_to_locale
+      result ? " - #{result}" : ""
+    end
+
+    private
+
+    def controller_params_to_locale
+      sections = params[:controller].to_s.split("/").compact.map(&:to_sym)
+      action = params[:action].to_s.to_sym
+      title = t(:titles)
+
+      sections.each do |s|
+        title = title.send("[]", s) if title.is_a?(Hash)
+      end
+      if title.is_a? Hash
+        title[action]
+      elsif title.is_a?(String) && !title.match(/class=\"translation_missing\"/)
+        title
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/axel/base_controller.rb

@@ -0,0 +1,6 @@
+require 'axel/controller_helpers'
+module Axel
+  class BaseController < ControllerBase.new.configured
+    include ControllerHelpers
+  end
+end

data/lib/axel/cascadable_attribute.rb

@@ -0,0 +1,33 @@
+module Axel
+  module CascadableAttribute
+    def inherited(klass)
+      super
+      _cascadable_attributes.each do |attribute_name|
+        klass.instance_variable_set "@#{attribute_name}", _instance_var_for("@#{attribute_name}")
+      end
+    end
+
+    def cascade_attribute(*attribute_names)
+      self._cascadable_attributes += attribute_names.map(&:to_s)
+    end
+
+    def _cascadable_attributes
+      @_cascadable_attributes ||= ["_cascadable_attributes"]
+    end
+
+    def _cascadable_attributes=(arry)
+      @_cascadable_attributes = arry
+    end
+
+    def _instance_var_for(attribute_name)
+      attribute = instance_variable_get(attribute_name)
+      attribute.clone
+    rescue
+      begin
+        attribute.dup
+      rescue
+        attribute
+      end
+    end
+  end
+end

data/lib/axel/configurations/resource.rb

@@ -0,0 +1,29 @@
+module Axel
+  module Configurations
+    class Resource
+      attr_reader :name
+      attr_reader :service
+      attr_accessor :attributes
+      attr_writer :path
+
+      def initialize(name, service, options = {})
+        @name = name.to_s.singularize
+        @service = service
+        @attributes = options[:attributes] || []
+        @path = options[:path] # If nil it will try to build URL from name and service
+      end
+
+      def full_url
+        URI.join(base_url, path).to_s
+      end
+
+      def base_url
+        service.url
+      end
+
+      def path
+        @path || name.pluralize
+      end
+    end
+  end
+end

data/lib/axel/configurations/service.rb

@@ -0,0 +1,28 @@
+require 'axel/configurations/resource'
+module Axel
+  module Configurations
+    class Service
+      attr_reader :name
+      attr_writer :url
+      attr_reader :resources
+
+      delegate :manual_environment_set?,
+        :environment,
+        to: Axel
+
+      def initialize(name, url)
+        @name = name.to_s.singularize
+        @resources = {}.with_indifferent_access
+        @url = url.to_s
+      end
+
+      def url
+        manual_environment_set? ? Uri.new(@url).to(*environment).to_s : @url
+      end
+
+      def add_resource(resource_name, options = {})
+        resources[resource_name] = Configurations::Resource.new(resource_name, self, options)
+      end
+    end
+  end
+end

data/lib/axel/configurator.rb

@@ -0,0 +1,54 @@
+require 'axel/configurators/services'
+module Axel
+  class Configurator
+    private
+    attr_writer :services
+    attr_writer :proxy
+    attr_writer :environment
+
+    public
+    attr_reader :services
+    attr_reader :proxy
+    attr_reader :environment
+    attr_writer :uses_rails_api
+    attr_reader :proxy_request_options
+    attr_accessor :environment_uri_config
+
+    def initialize
+      self.services = Configurators::Services.new
+    end
+
+    def service_configs
+      services.services
+    end
+
+    def resources
+      services.resources
+    end
+
+    def setup_proxy(url, request_options = {})
+      self.proxy = ApiProxy.new url, request_options
+      proxy.register!
+    end
+
+    def set_environment(name, stage_number = nil)
+      self.environment = [name, stage_number]
+    end
+
+    def manual_environment_set?
+      self.environment.present?
+    end
+
+    def add_service(service_name, url)
+      services.add_service service_name, url
+    end
+
+    def add_resource(service_name, resource_name, options = {})
+      services.add_resource service_name, resource_name, options
+    end
+
+    def uses_rails_api?
+      !!@uses_rails_api
+    end
+  end
+end