patchboard 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96e98fdd770b6bfa97c132fc1f7c9edfc01937c2
+  data.tar.gz: 4f854ad38cafa53c9775a73d668dfc20d7072e69
+SHA512:
+  metadata.gz: ac38663214aa9bb712080af92da4340a42128da75798b4408369d8dff343cd6b7e7896a80b4474705e9b16ce75a6f8c24a5e5643a1662dab493874c60a34c507
+  data.tar.gz: 82e03045526bcc3946fd9f5bbcdd66740f22a7f04a5fe462068df2124e5e91cc80fbca842e4fbc7b10db2fea70963b6776e8fe8a7068ca1a96b982fc3ecda456

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Matthew King
+
+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 @@
+# A Ruby client for Patchboard APIs

data/lib/patchboard/action.rb

@@ -0,0 +1,107 @@
+require_relative "response"
+
+class Patchboard
+
+  class Action
+
+    attr_reader :method, :headers, :status
+
+    def initialize(patchboard, name, definition)
+      @name = name
+      @patchboard = patchboard
+      @api = @patchboard.api
+      @schema_manager = @patchboard.schema_manager
+      @method = definition[:method]
+
+
+      @headers = {
+      }
+
+      request, response = definition[:request], definition[:response]
+
+      if request
+        @auth_scheme = request[:authorization]
+        if request[:type]
+          @headers["Content-Type"] = request[:type]
+          @request_schema = @schema_manager.find :media_type => request[:type]
+        end
+      end
+
+      if response && response[:type]
+        @headers["Accept"] = response[:type]
+        @response_schema = @schema_manager.find :media_type => response[:type]
+      end
+      @status = response[:status] || 200
+    end
+
+    def http
+      @http ||= @patchboard.http
+    end
+
+    def request(resource, url, *args)
+      options = self.prepare_request(resource, url, *args)
+      raw = self.http.request @method, url, options.merge(:response => :object)
+      response = Response.new(raw)
+      if response.status != @status
+        raise "Unexpected response status: #{response.status}"
+      end
+      out = @api.decorate(resource.context, @response_schema, response.data)
+      out.response = response
+      out
+    end
+
+    def prepare_request(resource, url, *args)
+      context = resource.context
+      headers = {}.merge(@headers)
+      options = {
+        :url => url, :method => @method, :headers => headers
+      }
+
+      if @auth_scheme && context.respond_to?(:authorizer)
+        credential = context.authorizer(@auth_scheme, resource, @name)
+        headers["Authorization"] = "#{@auth_scheme} #{credential}"
+      end
+
+      input_options = self.process_args(args)
+      if input_options[:body]
+        options[:body] = input_options[:body]
+      end
+      # This code looks forward to the time when we have figured out
+      # how we want Patchboard clients to take extra arguments for
+      # requests.  Leaving it here now to show why process_args returns a Hash,
+      # not just the body.
+      if input_options[:headers]
+        options[:headers].merge!(input_options[:headers])
+      end
+      options
+    end
+
+    def process_args(args)
+      options = {}
+      signature = args.map {|arg| arg.class.to_s }.join(".")
+      if @request_schema
+        case signature
+        when "String"
+          options[:body] = args[0]
+        when "Hash", "Array"
+          options[:body] = args[0].to_json
+        else
+          raise "Invalid arguments for action: request content is required"
+        end
+      else
+        case signature
+        when ""
+        else
+          raise "Invalid arguments for action"
+        end
+      end
+      options
+    end
+
+
+
+
+  end
+
+end
+

data/lib/patchboard/api.rb

@@ -0,0 +1,141 @@
+
+class Patchboard
+
+  class API
+    attr_reader :mappings, :resources, :schemas, :service_url
+
+    def initialize(definition)
+
+      @service_url = definition[:service_url]
+      @resources = Hashie::Mash.new definition[:resources]
+      @resources.each do |name, definition|
+        definition.name = name
+      end
+      @schemas = definition[:schemas]
+
+      @mappings = {}
+      definition[:mappings].each do |name, mapping|
+        @mappings[name] = Mapping.new(self, name, mapping)
+      end
+    end
+
+    def find_mapping(schema)
+      # TODO: stitch this into the actual schemas.
+      # ex:  schema.mapping
+      if id = (schema[:id] || schema[:$ref])
+        name = id.split("#").last
+        @mappings[name.to_sym]
+      end
+    end
+
+    def decorate(context, schema, data)
+      unless schema
+        return Hashie::Mash.new(data)
+      end
+
+      if mapping = self.find_mapping(schema)
+        # when we have a resource class, instantiate it using the input data.
+        data = mapping.klass.new context, data
+      else
+        # Otherwise traverse the schema in search of subschemas that have
+        # resource classes available.
+        case schema[:type]
+        when "array"
+          # TODO: handle the case where schema.items is an array, which
+          # signifies a tuple.  schema.additionalItems then becomes important.
+          data.map! do |item|
+            self.decorate(context, schema[:items], item)
+          end
+
+        when "object"
+          if schema[:properties]
+            schema[:properties].each do |key, prop_schema|
+              if value = data[key]
+                data[key] = self.decorate(context, prop_schema, value)
+              end
+            end
+          end
+          # TODO: handle schema.patternProperties
+          # TODO: consider alternative to iterating over all keys.
+          if schema[:additionalProperties]
+            data.each do |key, value|
+              next if schema[:properties] && schema[:properties][key]
+              data[key] = self.decorate(context, schema[:additionalProperties], value)
+            end
+          end
+          data = Hashie::Mash.new data
+        end
+      end
+      data
+    end
+
+
+  end
+
+  class Mapping
+
+    attr_accessor :klass
+    attr_reader :name, :resource, :url, :path, :template, :query
+
+    def initialize(api, name, definition)
+      @api = api
+      @name = name
+      @definition = definition
+      @resource = @definition[:resource]
+      @query = @definition[:query]
+      @url = @definition[:url]
+      @path = @definition[:path]
+      @template = @definition[:template]
+
+      unless (resource_name = @definition[:resource])
+        raise "Mapping does not specify 'resource'"
+      end
+
+      unless (@resource = @api.resources[resource_name.to_sym])
+        raise "Mapping specifies a resource that is not defined"
+      end
+
+      unless (@definition[:url] || @definition[:path] || @definition[:template])
+        raise "Mapping is missing any form of URL specification"
+      end
+
+    end
+
+    def generate_url(params={})
+      if @url
+        base = @url
+      elsif params[:url]
+        base = params[:url]
+      elsif @path
+        if @api.service_url
+          base = [@api.service_url, @path].join("/")
+        else
+          raise "Tried to generate url from path, but API did not define service_url"
+        end
+      elsif @template
+        raise "Template mappings are not yet implemented in the client"
+      end
+
+      if @query
+        parts = []
+        keys = @query.keys.sort()
+        # TODO check query schema
+        keys.each do |key|
+          if string = (params[key.to_s] || params[key.to_sym])
+            parts << "#{URI.escape(key.to_s)}=#{URI.escape(string)}"
+          end
+        end
+        if parts.size > 0
+          query_string = "?#{parts.join("&")}"
+        else
+          query_string = ""
+        end
+        [base, query_string].join()
+      else
+        base
+      end
+    end
+
+  end
+
+end

data/lib/patchboard/endpoints.rb

@@ -0,0 +1,49 @@
+class Patchboard
+
+  class Endpoints
+
+    def initialize(context, api, klasses)
+      @context = context
+      @api = api
+      @klasses = klasses
+
+      @api.mappings.each do |name, mapping|
+        if klass = @klasses[name]
+          if mapping.template || mapping.query
+            # A mapping with a template or query property requires
+            # additional input before it can express a usable URL.
+            # Thus the endpoint method takes parameters and instantiates
+            # a resource of the correct class.
+
+            define_singleton_method name do |params={}|
+              if params.is_a? String
+                url = params
+              else
+                url = mapping.generate_url(params)
+              end
+              klass.new(context, {:url => url})
+            end
+          elsif mapping.path
+            # When a mapping has the 'path' property, all that is needed to
+            # create a usable resource is the full URL.  Thus this endpoint
+            # method returns an instantiated resource directly.
+            define_singleton_method name do
+              klass.new(context, :url => mapping.generate_url())
+            end
+          elsif mapping.url
+            define_singleton_method name do
+              klass.new(context, :url => mapping.url)
+            end
+          else
+            raise "Mapping '#{name}' is invalid"
+          end
+        else
+          raise "No resource class for mapping '#{name}'"
+        end
+      end
+    end
+  end
+
+end
+
+

data/lib/patchboard/resource.rb

@@ -0,0 +1,111 @@
+
+class Patchboard
+
+  class Resource
+
+    def self.assemble(patchboard, definition, schema, mapping)
+
+      define_singleton_method(:api) do
+        patchboard.api
+      end
+
+      define_singleton_method(:mapping) do
+        mapping
+      end
+
+      define_singleton_method(:schema) do
+        schema
+      end
+
+      if schema && schema[:properties]
+        schema[:properties].each do |name, definition|
+          define_method name do
+            @attributes[name]
+          end
+        end
+      end
+
+      if schema && schema[:additionalProperties] != false
+        define_method :method_missing do |name, *args, &block|
+          if args.size == 0
+            @attributes[name.to_sym]
+          else
+            super(name, *args, &block)
+          end
+        end
+      end
+
+      define_singleton_method :generate_url do |params|
+        mapping.generate_url(params)
+      end
+
+      definition[:actions].each do |name, action|
+        action = Action.new(patchboard, name, action)
+
+        define_method name do |*args|
+          action.request self, @url, *args
+        end
+      end
+    end
+
+    def self.decorate(instance, attributes)
+      # TODO: non destructive decoration
+      # TODO: add some sort of validation for the input attributes.
+      # Hey, we have a JSON Schema, why not use it?
+      if self.schema && (properties = self.schema[:properties])
+        context = instance.context
+        properties.each do |key, sub_schema|
+          next unless (value = attributes[key])
+
+          if mapping = self.api.find_mapping(sub_schema)
+            if mapping.query
+              # TODO: find a way to define this at runtime, not once
+              # for every instance.
+              instance.define_singleton_method key do |params|
+                params[:url] = value[:url]
+                url = mapping.generate_url(params)
+                mapping.klass.new context, :url => url
+              end
+            else
+              attributes[key] = mapping.klass.new context, value
+            end
+          else
+            attributes[key] = self.api.decorate(context, sub_schema, value)
+          end
+
+        end
+      end
+      attributes
+    end
+
+    attr_accessor :response
+    attr_reader :url, :context, :attributes
+
+    def initialize(context, attributes={})
+      @context = context
+      @attributes = self.class.decorate self, Hashie::Mash.new(attributes)
+      @url = @attributes[:url]
+    end
+
+    def inspect
+      id = "%x" % (self.object_id << 1)
+      %Q{
+        #<#{self.class}:0x#{id}
+        @url="#{@url}" @context=#{@context}>
+      }.strip
+    end
+
+    def [](key)
+      @attributes[key]
+    end
+
+    def []=(key, value)
+      @attributes[key] = value
+    end
+
+
+    def curl
+    end
+  end
+
+end

data/lib/patchboard/response.rb

@@ -0,0 +1,29 @@
+class Patchboard
+  class Response
+
+    attr_accessor :resource
+    attr_reader :raw, :data
+    def initialize(raw)
+      @raw = raw
+      if @raw.headers["Content-Type"]
+        if @raw.headers["Content-Type"] =~ %r{application/.*json}
+          @data = JSON.parse @raw.body, :symbolize_names => true
+        end
+      end
+    end
+
+    def method_missing(name, *args, &block)
+      if @raw.respond_to? name
+        @raw.send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to?(*args)
+      @raw.respond_to?(*args) || super
+    end
+
+  end
+end
+

data/lib/patchboard/schema_manager.rb

@@ -0,0 +1,50 @@
+require "pp"
+class Patchboard
+
+  class SchemaManager
+
+    def initialize(schemas)
+      @schemas = schemas
+      @media_types = {}
+      @ids = {}
+      @names = {}
+
+      @schemas.each do |schema|
+        # TODO error checking for missing id
+        base_id = schema[:id].chomp("#")
+        schema[:definitions].each do |name, definition|
+          # `definitions` is the conventional place to put schemas,
+          # so we'll define fragment IDs by default where they are
+          # not explicitly specified.
+          id = definition[:id] || [base_id, name].join("#")
+          self.register_schema(id, definition)
+        end
+      end
+    end
+
+    def register_schema(id, schema)
+      schema[:id] = id
+      @ids[id] = schema
+      name = id.split("#")[1].to_sym
+      @names[name] = schema
+      if type = schema[:mediaType]
+        @media_types[type] = schema
+      end
+    end
+
+    def find(options)
+      if type = options[:mediaType] || options[:media_type]
+        @media_types[type]
+      elsif ref = options[:ref]
+        @ids[ref]
+      elsif name = options[:name]
+        @names[name]
+      else
+        raise "Unusable argument to find: #{options}"
+      end
+    end
+
+  end
+
+end
+

data/lib/patchboard/util.rb

@@ -0,0 +1,12 @@
+class Patchboard
+  module Util
+    module_function
+
+    def camel_case(arg)  
+      arg.to_s.split('_').map do |word|
+        "#{word.slice(/^\w/).upcase}#{word.slice(/^\w(\w+)/, 1)}"
+      end.join
+    end
+
+  end
+end

data/lib/patchboard.rb

@@ -0,0 +1,130 @@
+# Allows you to determine which methods are defined on a specific class
+# or module
+class Module
+  def local_methods
+    self.methods.select { |m| self.method(m).owner == self }
+  end
+  
+  def local_instance_methods
+    self.instance_methods.select { |m| self.instance_method(m).owner == self }
+  end
+end
+
+gem "http"
+gem "json"
+gem "hashie"
+
+require "http"
+require "json"
+require "hashie"
+
+require_relative "patchboard/api"
+require_relative "patchboard/util"
+require_relative "patchboard/resource"
+require_relative "patchboard/endpoints"
+require_relative "patchboard/action"
+require_relative "patchboard/schema_manager"
+
+class Patchboard
+
+  module Resources
+    # This module exists to provide a default namespace for the classes
+    # generated when reflecting on the API.  If Patchboard is instantiated
+    # with the option :namespace => SomeModule, that module will be used
+    # instead.
+  end
+
+
+  def self.http
+    @http ||= HTTP.with_headers "User-Agent" => "patchboard-rb v0.1.0"
+  end
+
+  def self.discover(url, options={}, &block)
+    begin
+      response = self.http.request "GET", url,
+        :response => :object,
+        :headers => {
+          "Accept" => "application/json"
+        }
+      data = JSON.parse(response.body, :symbolize_names => true)
+      self.new(data, options, &block)
+    rescue JSON::ParserError => error
+      raise "Unparseable API description: #{error}"
+    rescue Errno::ECONNREFUSED => error
+      raise "Problem discovering API: #{error}"
+    end
+  end
+
+  attr_reader :api, :resources, :http, :schema_manager, :context
+
+  def initialize(api, options={}, &block)
+    @api = API.new(api)
+    @options = options
+    @context_creator = block
+
+    if options[:namespace]
+      if options[:namespace].is_a? Module
+        @namespace = options[:namespace]
+      else
+        raise "Namespace must be a Module"
+      end
+    end
+
+    @endpoint_classes = {}
+
+    @schema_manager = SchemaManager.new(@api.schemas)
+
+    @http = self.class.http
+    self.create_classes()
+    client = self.spawn({})
+    @resources = client.resources
+    @context = client.context
+  end
+
+  def spawn(context=nil)
+    context ||= @context_creator.call
+    self.class::Client.new(context, @api, @endpoint_classes)
+  end
+
+  class Client
+
+    attr_reader :resources, :context
+    def initialize(context, api, klasses)
+      @context = context
+      @resources = Endpoints.new @context, api, klasses
+    end
+
+  end
+
+  def create_classes
+    klasses = {}
+    @api.mappings.each do |name, mapping|
+      resource_name = mapping.resource.name.to_sym
+      schema = @schema_manager.find :name => resource_name
+
+      klass = klasses[name] ||= begin
+        resource_def = mapping.resource
+        self.create_class(name, resource_def, schema, mapping)
+      end
+      @endpoint_classes[name] = klass
+    end
+  end
+
+  def create_class(resource_name, definition, schema, mapping)
+    patchboard = self
+
+    mapping.klass = klass = Class.new(self.class::Resource) do |klass|
+      self.assemble(patchboard, definition, schema, mapping)
+    end
+
+    if @namespace
+      @namespace.const_set Util.camel_case(resource_name).to_sym, klass
+    else
+      Patchboard::Resources.const_set Util.camel_case(resource_name).to_sym, klass
+    end
+    klass
+  end
+
+
+end
+

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: patchboard
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Matthew King
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: 
+email: automatthew@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/patchboard.rb
+- lib/patchboard/action.rb
+- lib/patchboard/api.rb
+- lib/patchboard/endpoints.rb
+- lib/patchboard/resource.rb
+- lib/patchboard/response.rb
+- lib/patchboard/schema_manager.rb
+- lib/patchboard/util.rb
+homepage: https://github.com/pandastrike/patchboard-rb
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Ruby client for Patchboard APIs
+test_files: []