jko_api 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3711a73e0bd2f3bb5186bf24f11d4530b9bbeb6c
+  data.tar.gz: e3a28ae1fc62c36cf5a3b77ee0f6820873fb9a75
+SHA512:
+  metadata.gz: c6adaaad9e11e56f1971934b7522dae6cc7376e18ddae3b3358202ee73dc85452327d5eab3a62c594e05f525ced2320ff1df5b1acbcf03b8e8ce0faedcbadc6a
+  data.tar.gz: 26a75d36b762ffa83d8f74f93374b5a843f73fdc9d1c80e3f969afdd68722d2055e9d527e239b722f70477304680f2de002490f19c041bace08d668cd4816bc3

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jko_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jeremy Woertink
+
+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,99 @@
+# JkoApi
+
+This is an API versioning gem for rails. Yes, there are a lot of really good and easy ones out there, but the issue with all of them is that when you make a version change, you're copying an entire folder of controllers, specs, and a bunch of routes over just for a single API change.
+
+This gem lets you make a single change and reversion an API without copying over a billion files and specs.
+
+## Props
+
+99% of this gem was written by [Justin Ko](https://github.com/justinko). Since he's lazy and won't make a gem from it, I'm doing it for him :stuck_out_tongue: That's why the gem is named after him.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jko_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jko_api
+
+## Usage
+
+In your `config/initializers/jko_api.rb` add
+
+```ruby
+JkoApi.configure do |c|
+  # This is the default. You can override this if you need a different controller
+  # c.base_controller = Api::ApplicationController
+  # This is the folder name where all the api controllers would go
+  # c.api_namespace = 'api'
+end
+```
+
+In your `config/routes.rb`
+
+```ruby
+JkoApi.routes self do
+  version 1 do
+    # put base routes and routes for version 1 here
+    resources :foos
+    resources :bars
+  end
+  version 2 # no route changes, maybe just a controller change
+  version 3 do
+    resources :bars, only: [:index] # only changes :bars in version 3
+  end
+end  
+```
+
+Place your version 1 controller code in `app/controllers/api/v1`. Controllers should all inherit from `Api::ApplicationController`, or something that inherits from that.
+
+```ruby
+class Api::V1::BarsController < Api::ApplicationController
+  def index
+    # do stuff
+  end
+  def show
+    # show stuff
+  end
+end
+```
+
+Any controllers that you need to alter will go into a new folder in `app/controllers/api/v2`. Notice in this one we inherit from the last version controller.
+
+```ruby
+class Api::V2::BarsController < Api::V1::BarsController
+  def index
+    # do different stuff
+  end
+  # no need to redefine show action because it didn't change
+end
+```
+
+We can still do this though
+
+```ruby
+class Api::V3::BarsController < Api::ApplicationController
+  def index
+    # do different stuff
+  end
+end
+```
+
+You can test this all by booting up a simple rails app, then do `curl -H "Accept: application/vnd.api.v1+json" http://localhost:3000/bars`
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/jko_api/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/app/controllers/api/application_controller.rb

@@ -0,0 +1,3 @@
+class Api::ApplicationController < ActionController::Base
+  include JkoApi::Controller
+end

data/jko_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jko_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jko_api"
+  spec.version       = JkoApi::VERSION
+  spec.authors       = ["Jeremy Woertink"]
+  spec.email         = ["jeremywoertink@gmail.com"]
+  spec.summary       = %q{A Rails API gem}
+  spec.description   = %q{Some Rails API code written by JustinKo and ported to a badly written gem}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "responders", "2.1.0"
+  spec.add_dependency "rails", ">= 4.2.0", "< 5"
+end

data/lib/jko_api.rb

@@ -0,0 +1,69 @@
+require "active_support/all"
+require "active_model/railtie"
+require "action_controller/railtie"
+require "responders"
+require "jko_api/version"
+require "jko_api/class_descendants_builder"
+require "jko_api/constraints"
+require "jko_api/controller"
+require "jko_api/controller_helpers"
+require "jko_api/middleware"
+require "jko_api/request_error"
+require "jko_api/responder"
+require "jko_api/versioning"
+require "jko_api/configuration"
+require "jko_api/util"
+require "jko_api/engine"
+
+
+module JkoApi
+  ACCEPT_HEADER_REGEX = /\Aapplication\/vnd\.api(\.v([0-9]))?\+json\z/
+
+  mattr_accessor :configuration, instance_accessor: false
+  mattr_reader :current_version_number, instance_reader: false
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+    setup(configuration.base_controller)
+  end
+
+  def self.setup(base_controller)
+    Util.stupid_hack!
+    ClassDescendantsBuilder.build base_controller, level: max_version_number
+  end
+
+  def self.activated?
+    current_version_number.present? && current_version_number > 0
+  end
+
+  def self.reset
+    self.current_version_number = nil
+  end
+
+  def self.current_version_number=(version_number)
+    @@current_version_number = version_number.to_i
+  end
+
+  def self.min_version_number
+    versioning.min_version_number
+  end
+
+  def self.max_version_number
+    versioning.max_version_number
+  end
+
+  def self.versioning
+    @@versioning || raise('call `.versions` first')
+  end
+
+  def self.versions(context, &block)
+    @@versioning = Versioning.new(context, &block)
+  end
+
+  def self.routes(context, &block)
+    context.scope(module: JkoApi.configuration.api_namespace, constraints: JkoApi::Constraints, defaults: {format: :json}) do
+      JkoApi.versions(context, &block)
+    end
+  end
+end

data/lib/jko_api/class_descendants_builder.rb

@@ -0,0 +1,46 @@
+module JkoApi
+  class ClassDescendantsBuilder
+    LEVEL_REGEX = /\d+/
+
+    def self.build(base_class, level:)
+      base_class.descendants.each do |descendant|
+        new(descendant, level).build
+      end
+    end
+
+    def initialize(descendant, level)
+      @descendant, @level = descendant, level
+    end
+
+    def build
+      initial_level.upto(@level - 1) do |level|
+        build_descendant(level) unless descendant_defined?(level)
+      end
+    end
+
+    private
+
+    def descendant_defined?(level)
+      !!swap_level(level.next).safe_constantize
+    end
+
+    def build_descendant(level)
+      namespace(level.next).constantize.const_set(
+        swap_level(level.next).demodulize,
+        Class.new(swap_level(level).constantize)
+      )
+    end
+
+    def namespace(level)
+      swap_level(level).deconstantize.presence || 'Object'
+    end
+
+    def swap_level(level)
+      @descendant.name.sub LEVEL_REGEX, level.to_s
+    end
+
+    def initial_level
+      @descendant.name[LEVEL_REGEX].to_i
+    end
+  end
+end

data/lib/jko_api/configuration.rb

@@ -0,0 +1,12 @@
+module JkoApi
+  class Configuration
+
+    attr_accessor :base_controller, :api_namespace
+
+    def initialize
+      @base_controller = Api::ApplicationController
+      @api_namespace = 'api'
+    end
+
+  end
+end

data/lib/jko_api/constraints.rb

@@ -0,0 +1,10 @@
+module JkoApi
+  module Constraints
+    def self.matches?(request)
+      request.headers['Accept'] &&
+      request.headers['Accept'].match(ACCEPT_HEADER_REGEX) &&
+      ::JkoApi.current_version_number.present?
+      # TODO: add condition config for specific subdomain
+    end
+  end
+end

data/lib/jko_api/controller.rb

@@ -0,0 +1,19 @@
+module JkoApi
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      include JkoApi::ControllerHelpers
+      skip_authentication # TODO: make this configurable
+
+      self.responder = JkoApi::Responder
+      respond_to :json
+    end
+
+  private
+
+    def render_json_errors(status, message = status)
+      render json: JkoApi::RequestError[status, message], status: status
+    end
+  end
+end

data/lib/jko_api/controller_helpers.rb

@@ -0,0 +1,29 @@
+module JkoApi
+  module ControllerHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :authenticated
+      self.authenticated = false
+      append_before_action { raise 'setup authentication' unless authenticated }
+    end
+
+    class_methods do
+      def authenticate(*args)
+        options, model_classes = args.extract_options!, args
+        options.reverse_merge! optional: false
+        # This is for use with Devise.
+        # TODO: make this configurable
+        # options[:fallback_to_devise] = !options.delete(:optional)
+        # model_classes.each do |model_class|
+        #   acts_as_token_authentication_handler_for model_class, options
+        # end
+        self.authenticated = true
+      end
+
+      def skip_authentication
+        self.authenticated = true
+      end
+    end
+  end
+end

data/lib/jko_api/engine.rb

@@ -0,0 +1,9 @@
+require 'rails/railtie'
+
+module JkoApi
+  class Engine < ::Rails::Engine
+    initializer "jko_api.configure_rails_initialization" do |app|
+      app.middleware.use JkoApi::Middleware
+    end
+  end
+end

data/lib/jko_api/middleware.rb

@@ -0,0 +1,25 @@
+module JkoApi
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if version_number = extract_version_number(env)
+        ::JkoApi.current_version_number = version_number
+      else
+        ::JkoApi.reset
+      end
+      @app.call env
+    end
+
+    private
+
+    def extract_version_number(env)
+      accept_header = env['HTTP_ACCEPT']
+      return false unless accept_header
+      accept_header[ACCEPT_HEADER_REGEX, 2] ||
+      accept_header[ACCEPT_HEADER_REGEX] && ::JkoApi.max_version_number
+    end
+  end
+end

data/lib/jko_api/request_error.rb

@@ -0,0 +1,33 @@
+module JkoApi
+  class RequestError
+    def self.[](status, message = status)
+      new(status, message).representer
+    end
+
+    attr_reader :status, :message
+
+    def initialize(status, message)
+      @status, @message = status, message
+    end
+
+    def representer
+      # TODO: integrate this somehow
+    end
+
+    private
+
+    def errors
+      Errors.new(MockRequest.new).tap do |errors|
+        errors.add :base, message
+      end
+    end
+
+    class MockRequest
+      include ::ActiveModel::Model
+
+      def representable_type
+        :requests
+      end
+    end
+  end
+end

data/lib/jko_api/responder.rb

@@ -0,0 +1,60 @@
+module JkoApi
+  class Responder < ActionController::Responder
+    protected
+
+    def display(model, *args)
+      options[:user]        ||= controller.current_user
+      options[:wrap]        ||= controller.wrap
+      options[:representer] ||= controller.representer
+
+      if first_model = Array.wrap(model).first
+        options[:wrap] ||= first_model.class.table_name
+      end
+
+      options[:wrap] || raise('set the `wrap` in the controller')
+      representer = options[:representer] || first_model.representer
+
+      if Array === model || ActiveRecord::Relation === model
+        representer = representer.for_collection
+      end
+
+      super representer.prepare(model), *args
+    end
+
+    def api_behavior
+      raise MissingRenderer.new(format) unless has_renderer?
+
+      if put?
+        display resource, status: :ok, location: api_location
+      elsif delete?
+        display resource, status: :ok
+      else
+        super
+      end
+    end
+
+    def api_location
+      if !options[:location] && controller.controller_name.starts_with?('user_')
+        options[:location] = user_resource_api_location
+      else
+        super
+      end
+    end
+
+    def user_resource_api_location
+      url_helpers = Rails.application.routes.url_helpers
+      url_method = controller.controller_name
+      url_method = url_method.singularize unless resources.many?
+      url_method = url_method + '_url'
+      if resources.many?
+        url_helpers.public_send url_method
+      else
+        url_helpers.public_send url_method, resource
+      end
+    end
+
+    def json_resource_errors
+      resource.errors
+    end
+  end
+end

data/lib/jko_api/util.rb

@@ -0,0 +1,18 @@
+module JkoApi
+  class Util
+
+    def self.stupid_hack!
+      Rails.application.reload_routes!
+      eager_load_api_controllers
+    end
+
+    def self.eager_load_api_controllers
+      [Rails.root.join('app', 'controllers')].each do |load_path|
+        matcher = /\A#{Regexp.escape(load_path.to_s)}\/(.*)\.rb\Z/
+        Dir.glob("#{load_path}/#{JkoApi.configuration.api_namespace}/**/*.rb").sort.each do |file|
+          require_dependency file.sub(matcher, '\1')
+        end
+      end
+    end
+  end
+end

data/lib/jko_api/version.rb

@@ -0,0 +1,3 @@
+module JkoApi
+  VERSION = "0.1.3"
+end

data/lib/jko_api/versioning.rb

@@ -0,0 +1,27 @@
+module JkoApi
+  class Versioning
+    def initialize(context, &block)
+      @context, @definitions = context, {}
+      instance_eval &block
+    end
+
+    def version(number, &block)
+      @definitions[number] = block || Proc.new {}
+      @context.scope module: "v#{number}", constraints: ->(*) {
+        JkoApi.current_version_number == number
+      } do
+        number.downto(min_version_number) do |i|
+          @context.instance_eval &@definitions[i]
+        end
+      end
+    end
+
+    def min_version_number
+      @definitions.keys.min
+    end
+
+    def max_version_number
+      @definitions.keys.max
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: jko_api
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Jeremy Woertink
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Some Rails API code written by JustinKo and ported to a badly written
+  gem
+email:
+- jeremywoertink@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/api/application_controller.rb
+- jko_api.gemspec
+- lib/jko_api.rb
+- lib/jko_api/class_descendants_builder.rb
+- lib/jko_api/configuration.rb
+- lib/jko_api/constraints.rb
+- lib/jko_api/controller.rb
+- lib/jko_api/controller_helpers.rb
+- lib/jko_api/engine.rb
+- lib/jko_api/middleware.rb
+- lib/jko_api/request_error.rb
+- lib/jko_api/responder.rb
+- lib/jko_api/util.rb
+- lib/jko_api/version.rb
+- lib/jko_api/versioning.rb
+homepage: ''
+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: A Rails API gem
+test_files: []