heroku_api_stub 0.1.7

data/lib/heroku_api_stub.rb

@@ -0,0 +1,5 @@
+require "multi_json"
+require "sinatra"
+
+require_relative "heroku_api_stub/generator"
+require_relative "heroku_api_stub/service_stub"

data/lib/heroku_api_stub/generator.rb

@@ -0,0 +1,77 @@
+module HerokuAPIStub
+  class Generator
+    def initialize(doc=nil)
+      @doc = doc || read_default
+    end
+
+    def run
+      @app = Sinatra.new(ServiceStub)
+      @doc["resources"].each do |_, resource|
+        example = build_example(resource["attributes"])
+        resource["actions"].each do |name, action|
+          method = action["method"]
+          path   = action["path"]
+          status = action["statuses"][0]
+          required_params, optional_params = build_param_logic(action)
+          # "{app}" to ":app"
+          path.gsub!(/{([a-z_]*)}/, ':\1')
+          #puts "method=#{method} path=#{path}"
+          @app.send(method.downcase, path) do
+            require_params!(required_params) if required_params
+            validate_params!(optional_params) if optional_params
+            if name == "List"
+              [status, MultiJson.encode([example], pretty: true)]
+            else
+              [status, MultiJson.encode(example, pretty: true)]
+            end
+          end
+        end
+      end
+      @app
+    end
+
+    private
+
+    def build_example(attributes)
+      example = {}
+      attributes.each do |name, info|
+        next if !info["serialized"]
+        keys = name.split(":")
+        hash = if (leading_keys = keys[0...-1]).size > 0
+          initialize_subhashes(example, leading_keys)
+        else
+          example
+        end
+        hash[keys.last] = info["example"]
+      end
+      example
+    end
+
+    def build_param_logic(action)
+      required_params =
+        action["attributes"] && action["attributes"]["required"]
+      optional_params =
+        action["attributes"] && action["attributes"]["optional"]
+      if required_params && !optional_params
+        optional_params = required_params
+      end
+      [required_params, optional_params]
+    end
+
+    # returns the last subhash that was initialized
+    def initialize_subhashes(hash, keys)
+      key = keys.shift
+      subhash = hash[key] || (hash[key] = {})
+      if keys.size > 0
+        initialize_subhashes(subhash, keys)
+      else
+        subhash
+      end
+    end
+
+    def read_default
+      path = File.expand_path("../../../data/doc.json", __FILE__)
+      MultiJson.decode(File.read(path))
+    end
+  end
+end

data/lib/heroku_api_stub/service_stub.rb

@@ -0,0 +1,59 @@
+module HerokuAPIStub
+  class ServiceStub < Sinatra::Base
+    before do
+      @body = MultiJson.decode(request.body.read) rescue {}
+      @keys = materialize_keys(@body)
+      check_authorized!
+      check_version!
+    end
+
+    private
+
+    def check_authorized!
+      if !request.env["HTTP_AUTHORIZATION"] ||
+        !(request.env["HTTP_AUTHORIZATION"] =~ /\A(Basic|Bearer)\s+(.*)/)
+        halt(401, MultiJson.encode(
+          id:      "unauthorized",
+          message: "Access denied."
+        ))
+      end
+    end
+
+    def check_version!
+      if request.env["HTTP_ACCEPT"] != "application/vnd.heroku+json; version=3"
+        halt(404, MultiJson.encode(
+          id:      "not_found",
+          message: "Not found."
+        ))
+      end
+    end
+
+    def materialize_keys(hash, prefix="")
+      keys = []
+      hash.each do |k, v|
+        if v.is_a?(Hash)
+          keys += materialize_keys(v, "#{prefix}#{k}:")
+        else
+          keys << prefix + k
+        end
+      end
+      keys
+    end
+
+    def require_params!(required)
+      missing = required - @keys
+      halt(400, MultiJson.encode(
+        id:      "invalid_params",
+        message: "Require params: #{missing.join(', ')}."
+      )) if missing.size > 0
+    end
+
+    def validate_params!(optional)
+      extra = @keys - optional
+      halt(400, MultiJson.encode(
+        id:      "invalid_params",
+        message: "Unknown params: #{extra.join(', ')}."
+      )) if extra.size > 0
+    end
+  end
+end

data/lib/heroku_api_stub/test.rb

@@ -0,0 +1,22 @@
+require "webmock"
+
+include WebMock::API
+
+module HerokuAPIStub
+  Stub = HerokuAPIStub::Generator.new.run
+
+  def self.initialize(&block)
+    url = ENV["HEROKU_API_URL"] || "https://api.heroku.com"
+    stub_service(url, Stub, &block)
+  end
+
+  private
+
+  def self.stub_service(uri, stub, &block)
+    uri = URI.parse(uri)
+    port = uri.port != uri.default_port ? ":#{uri.port}" : ""
+    stub = block ? Sinatra.new(stub, &block) : stub
+    stub_request(:any, /^#{uri.scheme}:\/\/(.*:.*@)?#{uri.host}#{port}\/.*$/).
+      to_rack(stub)
+  end
+end

data/spec/heroku_api_stub/generator_spec.rb

@@ -0,0 +1,55 @@
+require_relative "../spec_helper"
+
+describe HerokuAPIStub::Generator do
+  include Rack::Test::Methods
+
+  App = HerokuAPIStub::Generator.new.run
+
+  def app
+    App
+  end
+
+  before do
+    header "Accept", "application/vnd.heroku+json; version=3"
+    header "Authorization", "Bearer fake-access-token"
+  end
+
+  it "correctly serializes an app" do
+    get "/apps/anything"
+    assert_equal 200, last_response.status
+    assert_equal serialized_app, MultiJson.decode(last_response.body)
+  end
+
+  it "correctly serializes an app list" do
+    get "/apps"
+    assert_equal 200, last_response.status
+    assert_equal [serialized_app], MultiJson.decode(last_response.body)
+  end
+
+  private
+
+  def serialized_app
+    {
+      "buildpack_provided_description" => "Ruby/Rack",
+      "created_at" => "2012-01-01T12:00:00-00:00",
+      "git_url" => "git@heroku.com/example.git",
+      "id" => "01234567-89ab-cdef-0123-456789abcdef",
+      "maintenance" => false,
+      "name" => "example",
+      "owner" => {
+        "email" => "username@example.com",
+        "id" => "01234567-89ab-cdef-0123-456789abcdef"
+      },
+      "region" => {
+        "id" => "01234567-89ab-cdef-0123-456789abcdef",
+        "name" => "us"
+      },
+      "released_at" => "2012-01-01T12:00:00-00:00",
+      "repo_size" => 1024,
+      "slug_size" => 512,
+      "stack" => "cedar",
+      "updated_at" => "2012-01-01T12:00:00-00:00",
+      "web_url" => "http://example.herokuapp.com"
+    }
+  end
+end

data/spec/heroku_api_stub/service_stub_spec.rb

@@ -0,0 +1,154 @@
+require_relative "../spec_helper"
+
+describe HerokuAPIStub::ServiceStub do
+  include Rack::Test::Methods
+
+  class TestApp < HerokuAPIStub::ServiceStub
+    get "/" do
+      200
+    end
+
+    post "/require" do
+      require_params!(["key"])
+      200
+    end
+
+    post "/require-nested" do
+      require_params!(["key1:key2"])
+      200
+    end
+
+    post "/validate" do
+      validate_params!(["key"])
+      200
+    end
+
+    post "/validate-nested" do
+      validate_params!(["key1:key2"])
+      200
+    end
+  end
+
+  def app
+    TestApp
+  end
+
+  before do
+    header "Accept", "application/vnd.heroku+json; version=3"
+    header "Authorization", "Bearer fake-access-token"
+  end
+
+  describe "authorization" do
+    it "responds to basic authorization" do
+      header "Authorization", "Bearer fake-access-token"
+      get "/"
+      assert_equal 200, last_response.status
+    end
+
+    it "responds to bearer token authorization" do
+      header "Authorization", "Bearer fake-access-token"
+      get "/"
+      assert_equal 200, last_response.status
+    end
+
+    it "401s if unauthorized" do
+      header "Authorization", ""
+      get "/"
+      assert_equal 401, last_response.status
+    end
+  end
+
+  describe "versioning" do
+    it "responds to V3" do
+      header "Accept", "application/vnd.heroku+json; version=3"
+      get "/"
+      assert_equal 200, last_response.status
+    end
+
+    it "404s on other versions" do
+      header "Accept", "application/vnd.heroku+json; version=2"
+      get "/"
+      assert_equal 404, last_response.status
+    end
+  end
+
+  describe "parameter requirement" do
+    before do
+      header "Content-Type", "application/json"
+    end
+
+    it "recognizes a required key" do
+      post "/require", MultiJson.encode({
+        key: "val"
+      })
+      assert_equal 200, last_response.status
+    end
+
+    it "recognizes a nested required key" do
+      post "/require-nested", MultiJson.encode({
+        key1: { key2: "val" }
+      })
+      assert_equal 200, last_response.status
+    end
+
+    it "requires a key" do
+      post "/require", "{}"
+      assert_equal 400, last_response.status
+      assert_equal({
+        "id" => "invalid_params",
+        "message" => "Require params: key."
+      }, MultiJson.decode(last_response.body))
+    end
+
+    it "requires a nested key" do
+      post "/require-nested", "{}"
+      assert_equal 400, last_response.status
+      assert_equal({
+        "id" => "invalid_params",
+        "message" => "Require params: key1:key2."
+      }, MultiJson.decode(last_response.body))
+    end
+  end
+
+  describe "validation requirement" do
+    before do
+      header "Content-Type", "application/json"
+    end
+
+    it "recognizes a valid key" do
+      post "/validate", MultiJson.encode({
+        key: "val"
+      })
+      assert_equal 200, last_response.status
+    end
+
+    it "recognizes a nested valid key" do
+      post "/validate-nested", MultiJson.encode({
+        key1: { key2: "val" }
+      })
+      assert_equal 200, last_response.status
+    end
+
+    it "detects an invalid key" do
+      post "/validate", MultiJson.encode({
+        other: "val"
+      })
+      assert_equal 400, last_response.status
+      assert_equal({
+        "id" => "invalid_params",
+        "message" => "Unknown params: other."
+      }, MultiJson.decode(last_response.body))
+    end
+
+    it "requires a nested key" do
+      post "/validate-nested", MultiJson.encode({
+        key1: { other: "val" }
+      })
+      assert_equal 400, last_response.status
+      assert_equal({
+        "id" => "invalid_params",
+        "message" => "Unknown params: key1:other."
+      }, MultiJson.decode(last_response.body))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+ENV["RACK_ENV"] = "test"
+
+require "minitest/autorun"
+require "minitest/spec"
+require "rack/test"
+
+require_relative "../lib/heroku_api_stub"

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: heroku_api_stub
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+  prerelease: 
+platform: ruby
+authors:
+- Brandur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Service stub for the Heroku API.
+
+
+  Will respond to all public endpoints of the Heroku API with a sample serialized
+
+  response representing what data that endpoint would normal return. Useful in
+
+  development and testing situations where real API calls might result in
+
+  inconvienent manipulation of real data.
+
+'
+email: brandur@mutelight.org
+executables:
+- heroku-api-stub
+extensions: []
+extra_rdoc_files: []
+files:
+- ./data/doc.json
+- ./lib/heroku_api_stub/generator.rb
+- ./lib/heroku_api_stub/service_stub.rb
+- ./lib/heroku_api_stub/test.rb
+- ./lib/heroku_api_stub.rb
+- ./spec/heroku_api_stub/generator_spec.rb
+- ./spec/heroku_api_stub/service_stub_spec.rb
+- ./spec/spec_helper.rb
+- bin/heroku-api-stub
+homepage: https://github.com/heroku/heroku-api-stub
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Service stub for the Heroku API.
+test_files:
+- ./spec/heroku_api_stub/generator_spec.rb
+- ./spec/heroku_api_stub/service_stub_spec.rb
+- ./spec/spec_helper.rb