seahorse 0.1.0 → 1.0.0.pre1

data/Rakefile

@@ -1,7 +0,0 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-Bundler::GemHelper.install_tasks

data/lib/seahorse/api_translator/inflector.rb

@@ -1,37 +0,0 @@
-# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"). You
-# may not use this file except in compliance with the License. A copy of
-# the License is located at
-#
-#     http://aws.amazon.com/apache2.0/
-#
-# or in the "license" file accompanying this file. This file is
-# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-# ANY KIND, either express or implied. See the License for the specific
-# language governing permissions and limitations under the License.
-
-module Seahorse
-  class ApiTranslator
-
-    # @private
-    module Inflector
-
-      # Performs a very simple inflection on on the words as they are
-      # formatted in the source API configurations.  These are *not*
-      # general case inflectors.
-      # @param [String] string The string to inflect.
-      # @param [String,nil] format Valid formats include 'snake_case',
-      #   'camelCase' and `nil` (leave as is).
-      # @return [String]
-      def inflect string, format = nil
-        case format
-        when 'camelCase' then string.camelize
-        when 'snake_case' then string.underscore
-        else string
-        end
-      end
-    end
-
-  end
-end

data/lib/seahorse/api_translator/operation.rb

@@ -1,150 +0,0 @@
-# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"). You
-# may not use this file except in compliance with the License. A copy of
-# the License is located at
-#
-#     http://aws.amazon.com/apache2.0/
-#
-# or in the "license" file accompanying this file. This file is
-# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-# ANY KIND, either express or implied. See the License for the specific
-# language governing permissions and limitations under the License.
-
-require_relative './inflector'
-require_relative './shape'
-
-module Seahorse
-  class ApiTranslator
-
-    # @private
-    class Operation
-
-      include Inflector
-
-      def initialize rules, options = {}
-        @options = options
-
-        @method_name = rules['name'].sub(/\d{4}_\d{2}_\d{2}$/, '')
-        @method_name = inflect(@method_name, @options[:inflect_method_names])
-
-        @rules = rules
-
-        if @rules['http']
-          @rules['http'].delete('response_code')
-        end
-
-        translate_input
-        translate_output
-
-        if @options[:documentation]
-          @rules['errors'] = @rules['errors'].map {|e| e['shape_name'] }
-        else
-          @rules.delete('errors')
-          @rules.delete('documentation')
-          @rules.delete('documentation_url')
-          @rules.delete('response_code')
-        end
-      end
-
-      # @return [String]
-      attr_reader :method_name
-
-      # @return [Hash]
-      attr_reader :rules
-
-      private
-
-      def translate_input
-        if @rules['input']
-          rules = InputShape.new(@rules['input'], @options).rules
-          rules['members'] ||= {}
-          rules = normalize_inputs(rules)
-        else
-          rules = {
-            'type' => 'structure',
-            'members' => {},
-          }
-        end
-        @rules['input'] = rules
-      end
-
-      def translate_output
-        if @rules['output']
-          rules = OutputShape.new(@rules['output'], @options).rules
-          move_up_outputs(rules)
-          cache_payload(rules)
-        else
-          rules = {
-            'type' => 'structure',
-            'members' => {},
-          }
-        end
-        @rules['output'] = rules
-      end
-
-      def normalize_inputs rules
-        return rules unless @options[:type].match(/rest/)
-
-        xml = @options[:type].match(/xml/)
-        payload = false
-        wrapper = false
-
-        if rules['members'].any?{|name,rule| rule['payload'] }
-
-          # exactly one member has the payload trait
-          payload, rule = rules['members'].find{|name,rule| rule['payload'] }
-          rule.delete('payload')
-
-          #if rule['type'] == 'structure'
-          #  wrapper = payload
-          #  payload = [payload]
-          #end
-
-        else
-
-          # no members marked themselves as the payload, collect everything
-          # without a location
-          payload = rules['members'].inject([]) do |list,(name,rule)|
-            list << name if !rule['location']
-            list
-          end
-
-          if payload.empty?
-            payload = false
-          elsif xml
-            wrapper = @rules['input']['shape_name']
-          end
-
-        end
-
-        rules = { 'wrapper' => wrapper }.merge(rules) if wrapper
-        rules = { 'payload' => payload }.merge(rules) if payload
-        rules
-
-      end
-
-      def move_up_outputs output
-        move_up = nil
-        (output['members'] || {}).each_pair do |member_name, rules|
-          if rules['payload'] and rules['type'] == 'structure'
-            rules.delete('payload')
-            move_up = member_name
-          end
-        end
-
-        if move_up
-          output['members'].merge!(output['members'].delete(move_up)['members'])
-        end
-      end
-
-      def cache_payload rules
-        (rules['members'] || {}).each_pair do |member_name, rule|
-          rules['payload'] = member_name if rule['payload'] || rule['streaming']
-          rule.delete('payload')
-        end
-      end
-
-    end
-  end
-end

data/lib/seahorse/api_translator/shape.rb

@@ -1,235 +0,0 @@
-# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"). You
-# may not use this file except in compliance with the License. A copy of
-# the License is located at
-#
-#     http://aws.amazon.com/apache2.0/
-#
-# or in the "license" file accompanying this file. This file is
-# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-# ANY KIND, either express or implied. See the License for the specific
-# language governing permissions and limitations under the License.
-
-require_relative './inflector'
-
-module Seahorse
-  class ApiTranslator
-
-    # @private
-    class Shape
-
-      include Inflector
-
-      def initialize rules, options = {}
-        @options = options
-        @rules = {}
-        @rules['name'] = options['name'] if options.key?('name')
-        set_type(rules.delete('type'))
-        rules.each_pair do |method,arg|
-          send("set_#{method}", *[arg])
-        end
-      end
-
-      def rules
-        if @rules['type'] != 'blob'
-          @rules
-        elsif @rules['payload'] or @rules['streaming']
-          @rules.merge('type' => 'binary')
-        else
-          @rules.merge('type' => 'base64')
-        end
-      end
-
-      def xmlname
-        if @rules['flattened']
-          (@rules['members'] || {})['name'] || @xmlname
-        else
-          @xmlname
-        end
-      end
-
-      protected
-
-      def set_timestamp_format format
-        @rules['format'] = format
-      end
-
-      def set_type name
-        types = {
-          'structure' => 'structure',
-          'list' => 'list',
-          'map' => 'map',
-          'boolean' => 'boolean',
-          'timestamp' => 'timestamp',
-          'character' => 'string',
-          'double' => 'float',
-          'float' => 'float',
-          'integer' => 'integer',
-          'long' => 'integer',
-          'short' => 'integer',
-          'string' => 'string',
-          'blob' => 'blob',
-          'biginteger' => 'integer',
-          'bigdecimal' => 'float',
-        }
-        if name == 'string'
-          # Purposefully omitting type when string (to reduce size of the api
-          # configuration).  The parsers use string as the default when
-          # 'type' is omitted.
-          #@rules['type'] = 'string'
-        elsif type = types[name]
-          @rules['type'] = type
-        else
-          raise "unhandled shape type: #{name}"
-        end
-      end
-
-      def set_members members
-        case @rules['type']
-        when 'structure'
-          @rules['members'] = {}
-          members.each_pair do |member_name,member_rules|
-
-            member_shape = new_shape(member_rules)
-
-            member_key = inflect(member_name, @options[:inflect_member_names])
-            member_rules = member_shape.rules
-
-            if member_name != member_key
-              member_rules = { 'name' => member_name }.merge(member_rules)
-            end
-
-            if swap_names?(member_shape)
-              member_rules['name'] = member_key
-              member_key = member_shape.xmlname
-            end
-
-            @rules['members'][member_key] = member_rules
-
-          end
-        when 'list'
-          @rules['members'] = new_shape(members).rules
-        when 'map'
-          @rules['members'] = new_shape(members).rules
-        else
-          raise "unhandled complex shape `#{@rules['type']}'"
-        end
-        @rules.delete('members') if @rules['members'].empty?
-      end
-
-      def set_keys rules
-        shape = new_shape(rules)
-        @rules['keys'] = shape.rules
-        @rules.delete('keys') if @rules['keys'].empty?
-      end
-
-      def set_xmlname name
-        @xmlname = name
-        @rules['name'] = name
-      end
-
-      def set_location location
-        @rules['location'] = (location == 'http_status' ? 'status' : location)
-      end
-
-      def set_location_name header_name
-        @rules['name'] = header_name
-      end
-
-      def set_payload state
-        @rules['payload'] = true if state
-      end
-
-      def set_flattened state
-        @rules['flattened'] = true if state
-      end
-
-      def set_streaming state
-        @rules['streaming'] = true if state
-      end
-
-      def set_xmlnamespace ns
-        @rules['xmlns'] = ns
-      end
-
-      def set_xmlattribute state
-        @rules['attribute'] = true if state
-      end
-
-      def set_documentation docs
-        @rules['documentation'] = docs if @options[:documentation]
-      end
-
-      def set_enum values
-        @rules['enum'] = values if @options[:documentation]
-      end
-
-      def set_wrapper state
-        @rules['wrapper'] = true if state
-      end
-
-      # we purposefully drop these, not useful unless you want to create
-      # static classes
-      def set_shape_name *args; end
-      def set_box *args; end
-
-      # @param [Hash] rules
-      # @option options [String] :name The name this shape has as a structure member.
-      def new_shape rules
-        self.class.new(rules, @options)
-      end
-
-    end
-
-    # @private
-    class InputShape < Shape
-
-      def set_required *args
-        @rules['required'] = true;
-      end
-
-      def set_member_order order
-        @rules['order'] = order
-      end
-
-      def set_min_length min
-        @rules['min_length'] = min if @options[:documentation]
-      end
-
-      def set_max_length max
-        @rules['max_length'] = max if @options[:documentation]
-      end
-
-      def set_pattern pattern
-        @rules['pattern'] = pattern if @options[:documentation]
-      end
-
-      def swap_names? shape
-        false
-      end
-
-    end
-
-    # @private
-    class OutputShape < Shape
-
-      # these traits are ignored for output shapes
-      def set_required *args; end
-      def set_member_order *args; end
-      def set_min_length *args; end
-      def set_max_length *args; end
-      def set_pattern *args; end
-
-      def swap_names? shape
-        if @options[:documentation]
-          false
-        else
-          !!(%w(query rest-xml).include?(@options[:type]) and shape.xmlname)
-        end
-      end
-
-    end
-
-  end
-end

data/lib/seahorse/controller.rb

@@ -1,87 +0,0 @@
-require_relative './param_validator'
-
-module Seahorse
-  module Controller
-    extend ActiveSupport::Concern
-
-    included do
-      respond_to :json, :xml
-
-      rescue_from Exception, :with => :render_error
-
-      wrap_parameters false
-
-      before_filter do
-        @params = params
-        @params = operation.input.from_input(params, false)
-        @params.update(operation.input.from_input(map_headers, false))
-
-        begin
-          input_rules = operation.to_hash['input']
-          %w(action controller format).each {|v| params.delete(v) }
-          validator = Seahorse::ParamValidator.new(input_rules)
-          validator.validate!(params)
-        rescue ArgumentError => error
-          if request.headers['HTTP_USER_AGENT'] =~ /sdk|cli/
-            service_error(error, 'ValidationError')
-          else
-            raise(error)
-          end
-        end
-
-        @params = operation.input.from_input(@params)
-        @params = params.permit(*operation.input.to_strong_params)
-
-        true
-      end
-    end
-
-    private
-
-    def render_error(exception)
-      service_error(exception, exception.class.name)
-    end
-
-    def params
-      @params || super
-    end
-
-    def respond_with(model, opts = {})
-      opts[:location] = nil
-      if opts[:error]
-        opts[:status] = opts[:error]
-        super
-      else
-        super(operation.output.to_output(model), opts)
-      end
-    end
-
-    def operation
-      return @operation if @operation
-      @operation = api_model.operation_from_action(action_name)
-    end
-
-    def api_model
-      return @api_model if @api_model
-      @api_model = ('Api::' + controller_name.singularize.camelcase).constantize
-    end 
-
-    def service_error(error, code = 'ServiceError', status = 400)
-      respond_with({ code: code, message: error.message }, error: status)
-    end
-
-    def map_headers
-      return @map_headers if @map_headers
-      @map_headers = {}
-      return @map_headers unless operation.input.default_type == 'structure'
-      operation.input.members.each do |name, member|
-        if member.header
-          hdr_name = member.header == true ? name : member.header
-          hdr_name = "HTTP_" + hdr_name.upcase.gsub('-', '_')
-          @map_headers[name] = request.headers[hdr_name]
-        end
-      end
-      @map_headers
-    end
-  end
-end

data/lib/seahorse/model.rb

@@ -1,82 +0,0 @@
-module Seahorse
-  module Model
-    @@apis ||= {}
-
-    class << self
-      def apis; @@apis end
-
-      def add_all_routes(router)
-        Dir.glob("#{Rails.root}/app/models/api/*.rb").each {|f| load f }
-        @@apis.values.each {|api| api.add_routes(router) }
-      end
-    end
-
-    extend ActiveSupport::Concern
-
-    included do
-      @@apis[name.underscore.gsub(/_api$|^api\//, '')] = self
-    end
-
-    module ClassMethods
-      attr_reader :operations
-
-      def model_name
-        name.underscore.gsub(/_api$|^api\//, '')
-      end
-
-      def add_routes(router)
-        Seahorse::Router.new(self).add_routes(router)
-      end
-
-      def desc(text)
-        @desc = text
-      end
-
-      def operation(name, &block)
-        name, action = *operation_name_and_action(name)
-        @actions ||= {}
-        @operations ||= {}
-        @operations[name] = Operation.new(self, name, action, &block)
-        @operations[name].documentation = @desc
-        @actions[action] = @operations[name]
-        @desc = nil
-      end
-
-      def operation_from_action(action)
-        @actions ||= {}
-        @actions[action]
-      end
-
-      def type(name, &block)
-        supertype = 'structure'
-        name, supertype = *name.map {|k,v| [k, v] }.flatten if Hash === name
-        ShapeBuilder.type(name, supertype, &block)
-      end
-
-      def to_hash
-        ops = @operations.inject({}) do |hash, (name, operation)|
-          hash[name.camelcase(:lower)] = operation.to_hash
-          hash
-        end
-        {'operations' => ops}
-      end
-
-      private
-
-      def operation_name_and_action(name)
-        if Hash === name
-          name.to_a.first.map(&:to_s).reverse
-        else
-          case name.to_s
-          when 'index', 'list'
-            ["list_#{model_name.pluralize}", 'index']
-          when 'show'
-            ["get_#{model_name}", name.to_s]
-          else
-            ["#{name}_#{model_name}", name.to_s]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/seahorse/operation.rb

@@ -1,66 +0,0 @@
-module Seahorse
-  class Operation
-    attr_reader :name, :verb, :action
-    attr_accessor :documentation
-
-    def initialize(controller, name, action = nil, &block)
-      @name = name.to_s
-      @action = action.to_s
-      @controller = controller
-      url_prefix = "/" + controller.model_name.pluralize
-      url_extra = nil
-
-      case action.to_s
-      when 'index'
-        @verb = 'get'
-      when 'show'
-        @verb = 'get'
-        url_extra = ':id'
-      when 'destroy', 'delete'
-        @verb = 'delete'
-        url_extra = ':id'
-      when 'create'
-        @verb = 'post'
-      when 'update'
-        @verb = 'put'
-      else
-        @verb = 'get'
-        url_extra = name.to_s
-      end
-      @url = url_prefix + (url_extra ? "/#{url_extra}" : "")
-
-      instance_eval(&block)
-    end
-
-    def verb(verb = nil)
-      verb ? (@verb = verb) : @verb
-    end
-
-    def url(url = nil)
-      url ? (@url = url) : @url
-    end
-
-    def input(type = nil, &block)
-      @input ||= ShapeBuilder.type_class_for(type || 'structure').new
-      type || block ? ShapeBuilder.new(@input).build(&block) : @input
-    end
-
-    def output(type = nil, &block)
-      @output ||= ShapeBuilder.type_class_for(type || 'structure').new
-      type || block ? ShapeBuilder.new(@output).build(&block) : @output
-    end
-
-    def to_hash
-      {
-        'name' => name.camelcase,
-        'http' => {
-          'uri' => url.gsub(/:(\w+)/, '{\1}'),
-          'method' => verb.upcase
-        },
-        'input' => input.to_hash,
-        'output' => output.to_hash,
-        'documentation' => documentation
-      }
-    end
-  end
-end