axel 0.0.1

data/lib/axel/uri.rb

@@ -0,0 +1,47 @@
+module Axel
+  class Uri < Typhoid::Uri
+    def config
+      (
+        Axel._config.environment_uri_config || {}
+      ).with_indifferent_access
+    end
+
+    def to(config_key, staging_number = nil)
+      new_base = apply_suffix dashed_app_name,
+        staging_number,
+        config_for(config_key)[:host]
+      base.host = new_base
+      base.scheme = config_for(config_key)[:scheme]
+      self
+    end
+
+    def app_name
+      dashed_app_name.underscore.humanize.titleize
+    end
+
+    def dashed_app_name
+      base.host.to_s.gsub(/\..*$/, "")
+    end
+
+    def config_for(config_key)
+      config[config_key] || default_handler
+    end
+    private :config_for
+
+    def default_handler
+      config[:default] || { host: ".dev", scheme: "http" }
+    end
+    private :default_handler
+
+    def apply_suffix(base_name, staging_number, config_handler)
+      config_handler = convert_string_to_proc config_handler
+      config_handler.call base_name, staging_number
+    end
+    private :apply_suffix
+
+    def convert_string_to_proc(handler)
+      handler.is_a?(Proc) ? handler : Proc.new { |base, n| "#{base}#{handler}" }
+    end
+    private :convert_string_to_proc
+  end
+end

data/lib/axel/version.rb

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

data/lib/generators/axel/install_generator.rb

@@ -0,0 +1,16 @@
+module Axel
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates a Axel initializer."
+
+      def copy_initializer
+        template "axel.rb", "config/initializers/axel.rb"
+      end
+
+      def show_readme
+        readme "README.md" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README.md

@@ -0,0 +1,22 @@
+--------------------------------------
+
+# Welcome to Axel
+
+## Configuration
+
+In your `app/controllers/application_controller.rb` change to:
+
+```ruby
+class ApplicationController < Axel::BaseController
+  layout "axel" # For json and xml API output
+  #.......
+  #.......
+end
+```
+
+Please see `config/initializers/axel.rb` to configure inter-service connection.
+
+You'll also want to have a look at the README.md found at the project homepage:
+http://github.com/tstmedia/axel.  There you'll find more information about what the
+`Axel::BaseController` can do for your API controllers and how to operate inter-
+service requests.

data/lib/generators/templates/axel.rb

@@ -0,0 +1,81 @@
+Axel.config do |config|
+  # The API Proxy's `/registry` endpoint holds information about
+  # what resources connect to what services and where. We can leverage
+  # that endpoint to automatically configure objects for data retrieval
+  # and creation. To start, you'll want to configure the API Proxy location for
+  # automatically retrieving resource location configs:
+  #
+  #   config.set_proxy_url "http://api.your-platform.com"
+  #
+  # Services may be added manually:
+  #
+  #   config.add_service "github", "http://api.github.com/v3/"
+  #
+  # Service locations can be forced to a specific URL:
+  #
+  #   config.service_configs[:user_service].url = "http://localhost:1337"
+  #
+  # Because of the API Proxy, many resources should be available automatically.
+  # You can then start setting what attributes you want easier access
+  # to for certain resources:
+  #
+  #   config.resources[:users].attributes << :user_name
+  #   config.resources[:personas].attributes = [:first_name, :last_name]
+  #
+  # While many resources are automatically created, you can also manually add
+  # resources:
+  #
+  #   config.add_resource "github", "repos" # `, service: { url: ".." } needed if the service was not added previously
+  #
+  # Resources can set their paths manually:
+  #
+  #   config.resources[:personas].path = "people"
+  #
+  # The Api proxy config and configs for altering resources/services will make
+  # it so when you inherit from Axel::ServiceResource::Base you get some
+  # free configuration. Example:
+  #
+  #   module MyApp
+  #     class User
+  #       resource # => <#Axel::Configurations::Resource users service: #<Axel::Configurations::Service user-service>>
+  #       path     # => "/users"
+  #       site     # => "https://user-service.your-platform.com"
+  #     end
+  #   end
+  #
+  # To configure URI conversion to certain environment URIs. Strategies
+  # are either suffix strings or Procs that accept a base-name (usually app name)
+  # and a number (for staging numbers). Define strategies here like so:
+  #
+  #   config.environment_uri_config = {
+  #     dev: {
+  #       host: ".dev",
+  #       scheme: "http"
+  #     },
+  #     stage: {
+  #       host: ->(base, n) { "#{base}.stage#{n}.ngin-staging.com" },
+  #       scheme: "https"
+  #     },
+  #     prod: {
+  #       host: ".your-platform.com",
+  #       scheme: "https"
+  #     }
+  #   }
+  #
+  # This now means you can do:
+  #
+  #   Axel::Uri.new("http://user-service.dev/users").to(:prod).to_s
+  #   # => "http://user-service.your-platform.com/users"
+  #
+  # With that set you can quickly convert all URLs in objects that use axel
+  # for resource location to another environment:
+  #
+  #   config.set_environment :stage, 2
+  #
+  # Do you use rails-api instead of Rails proper? Set:
+  #
+  #   config.uses_rails_api = true  # Default: false
+  #
+  # This ensures that you use the ActionController::API rather than Rails' default
+  # ActionController::Base
+end

data/script/rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_PATH = File.expand_path('../..',  __FILE__)
+load File.expand_path('../../spec/dummy/script/rails',  __FILE__)

data/spec/controllers/pages_controller_spec.rb

@@ -0,0 +1,217 @@
+require 'spec_helper'
+Page = Class.new
+describe PagesController do
+  it "gets json" do
+    get :show, format: :json
+    subject.send(:_layout).should == "axel"
+  end
+
+  it "gets xml" do
+    get :show, format: :xml
+    subject.send(:_layout).should == "axel"
+  end
+
+  it "doesn't get any" do
+    get :show # This helper defailts to html which we haven't specified to handle
+    response.code.should == "406"
+  end
+
+  its(:metadata) { should be_a Axel::Payload::Metadata }
+
+  context "rescue error" do
+    context "list of errors and 403" do
+      let(:messages) { ["Broke 1", "Broke 2"] }
+      let(:params) { { format: :json } }
+      before do
+        subject.stub respond_to: true
+        subject.rescue_error messages: messages, status: :forbidden
+      end
+
+      it "sets error object" do
+        subject.errors.display.should == { status: 403, messages: messages }
+      end
+    end
+  end
+
+  context "query helpers" do
+    its(:query_params) { should be_a HashWithIndifferentAccess }
+    its(:post_params) { should be_a HashWithIndifferentAccess }
+  end
+
+  context "formatters" do
+    context "format" do
+      its(:format) { should == :json }
+      its(:render_nil_format) { should be_nil }
+      context "with format param" do
+        before { subject.stub params: { format: :xml } }
+
+        its(:format) { should == :xml }
+        its(:render_nil_format) { should == "" }
+      end
+    end
+  end
+
+  context "rabl render" do
+    let(:string) { "" }
+    it "asks rabl to render" do
+      Rabl.should_receive(:render).with string, "view", view_path: "app/views", scope: subject
+      subject.rabl_render string, "view"
+    end
+  end
+
+  context "xml_clean" do
+    let(:non_dirty) { <<-XML
+<document>
+  <metadata>
+    <current_user nil="true"/>
+  </metadata>
+  <result>
+  </result>
+</document>
+    XML
+    }
+
+    let(:dirty) { <<-XML
+<document>
+  <metadata>
+    <?xml version="1.0" encoding="UTF-8"?>
+    <hash>
+      <current_user nil="true"/>
+    </hash>
+  </metadata>
+  <result>
+  </result>
+</document>
+    XML
+    }
+
+    let(:cleaned) { <<-XML
+<document>
+  <metadata>
+    
+          <current_user nil="true"/>
+      </metadata>
+  <result>
+  </result>
+</document>
+    XML
+    }
+
+    it "doesn't touch the non_dirty" do
+      subject.xml_clean(non_dirty).should == non_dirty.strip
+    end
+
+    it "cleans the dirty payload" do
+      subject.xml_clean(dirty).should == cleaned.strip
+    end
+  end
+
+  context "render action" do
+    context "method" do
+      let(:formatter) { double }
+      it "calls formatter with action" do
+        subject.should_receive(:respond_with).and_yield formatter
+        subject.should_receive(:render).with({ action: :show}).twice
+        formatter.should_receive(:json).and_yield
+        formatter.should_receive(:xml).and_yield
+        subject.respond_with_action(:show)
+      end
+    end
+
+    context "id param" do
+      let(:page) { Page.new }
+      context "found record" do
+        before do
+          subject.stub params: { id: 1 }
+          Page.should_receive(:where).with(:id => 1).and_return [page]
+        end
+
+        its(:find_resource) { should == page }
+      end
+
+      context "no record" do
+        let(:page) { Page.new }
+        before do
+          subject.stub params: { id: 1 }
+          Page.should_receive(:where).with(:id => 1).and_return []
+        end
+
+        it "raises not found" do
+          expect { subject.find_resource }.to raise_error Axel::RecordNotFound
+        end
+      end
+
+      context "with custom finder and value" do
+        before do
+          subject.stub params: { id: 1 }
+          Page.should_not_receive(:where).with(:id => 1)
+          Page.should_receive(:where).with(:name => "two").and_return [page]
+        end
+
+        it "raises not found" do
+          subject.find_resource(finder: :name, value: "two").should == page
+        end
+      end
+    end
+  end
+
+  context "drop meta" do
+    context "doesn't drop meta" do
+      its(:drop_meta?) { should be_falsey }
+    end
+
+    context "drops meta" do
+      before do
+        subject.drop_meta!
+      end
+
+      its(:drop_meta?) { should be_truthy }
+    end
+  end
+
+  context "object_params" do
+    context "nested in object name" do
+      before do
+        subject.stub post_params: { page: { id: 1 } }.with_indifferent_access
+      end
+
+      its(:object_params) { should == { id: 1 }.with_indifferent_access }
+    end
+
+    context "not nested in name" do
+      before do
+        subject.stub post_params: { id: 1 }.with_indifferent_access
+      end
+
+      its(:object_params) { should == { id: 1 }.with_indifferent_access }
+    end
+  end
+
+  context "object_name" do
+    its(:object_name) { should == "page" }
+  end
+
+  context "force_ssl!" do
+    its(:force_ssl!) { should be_truthy }
+
+    context "productionish" do
+      before do
+        Rails::Application.stub productionish?: true
+      end
+
+      it "raises force ssl error" do
+        expect { subject.force_ssl! }.to raise_error Axel::ForceSSL
+      end
+    end
+  end
+
+  describe "safe_json_load" do
+    it "loads a string of json" do
+      subject.safe_json_load("{ \"user\": true }").should == { "user" => true }
+    end
+
+    it "returns nil for no json" do
+      subject.safe_json_load(nil).should == nil
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.