icss 0.1.3 → 0.3.2

data/CHANGELOG.textile

@@ -1,9 +0,0 @@
-h3. v0.1.0 June 7 2011
-
-* New receiver from gorillib
-
-h3. v0.0.3 May 22 2011
-
-* used gorillib, got rid of active_support, extlib HOORAY
-* moved Receiver to gorillib.
-* *breaking change*. Gorillib changed the signature of receive() to be @receive(*constructor_args, hsh)@ (formerly, the hsh was first).

data/Gemfile.lock

@@ -1,40 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activesupport (3.0.9)
-    builder (2.1.2)
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    gorillib (0.1.1)
-    i18n (0.5.0)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    rake (0.8.7)
-    rcov (0.9.9)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-    yard (0.6.8)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activemodel (~> 3.0.9)
-  bundler (~> 1.0.0)
-  gorillib (~> 0.1.1)
-  jeweler (~> 1.5.2)
-  rcov
-  rspec (~> 2.3.0)
-  yard (~> 0.6.0)

data/README.textile

@@ -1,29 +0,0 @@
-h2. The Infochimps Stupid Schema (ICSS)
-
-An ICSS file is a *complete*, *expressive* description of a collection of related data and all associated assets.
-
-Assets may include
-* data assets (including their location and schema)
-* code for api calls (messages) based on the the described records (including their call signature and schema)
-* other referenced schema
-
-See "icss_specification.textile":icss/blob/master/icss_specification.textile for more.
-
-
-h2. Colophon
-
-h3. Contributing to icss
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-h3. Copyright
-
-Copyright (c) 2011 Philip (flip) Kromer for Infochimps. See LICENSE.txt for
-further details.
-

data/lib/icss/brevity.rb

@@ -1,136 +0,0 @@
-#
-# Doing
-#
-#     require 'icss/brevity'
-#
-# makes the #inspect method on Icss::Type's be nice and readable,
-# not GIGANTE PIQUANTE OY CABRON
-#
-#
-module Icss
-
-  Protocol.class_eval do
-    def inspect
-      ["#<#{self.class.name}",
-        inspect_hsh.map{|k,v| "#{k}=#{v}" },
-        ">"
-      ].join(" ")
-    end
-
-    def inspect_hsh
-      {
-        :name        => name,
-        :namespace   => @namespace,
-        :types       => (types||[]).map(&:name).inspect,
-        :messages    => (messages||{}).values.map(&:name).inspect,
-        :data_assets => (data_assets||[]).map(&:name).inspect,
-        :doc         => "'#{(doc||"")[0..30].gsub(/[\n\t\r]+/,' ')}...'",
-      }
-    end
-  end
-
-  Message.class_eval do
-    def inspect
-      ["#<#{self.class.name}",
-        inspect_hsh.map{|k,v| "#{k}=#{v}" },
-        ">"
-      ].join(" ")
-    end
-
-    private
-    # stuff a compact cartoon of the fields in there
-    def inspect_hsh
-      {
-        :name        => name,
-        :request     => summary_of_request_attr, # (request||[]).map(&:type).map(&:name),
-        :response    => summary_of_response_attr,
-        :errors      => errors.inspect,
-        :protocol    => (protocol.present? ? protocol.protocol : nil),
-        :doc         => "'#{(doc||"")[0..30].gsub(/[\n\t\r]+/,' ')}...'",
-      }
-    end
-  end
-
-  Type.class_eval do
-    def inspect
-      ["#<#{self.class.name}",
-        @type,
-        inspect_hsh.map{|k,v| "#{k}=#{v}" },
-        ">",
-      ].compact.join(" ")
-    end
-  private
-    def inspect_hsh
-      { :name        => name,
-        :doc         => "'#{(doc||"")[0..30].gsub(/[\n\t\r]+/,' ')}...'", }
-    end
-  end
-
-  RecordField.class_eval do
-    def inspect
-      ["#<#{self.class.name}",
-        inspect_hsh.map{|k,v| "#{k}=#{v}" },
-        ">",
-      ].compact.join(" ")
-    end
-  private
-    def inspect_hsh
-      { :name        => name,
-        :type        => expand_type,
-        :default     => default,
-        :order       => @order,
-        :doc         => "'#{(doc||"")[0..30].gsub(/[\n\t\r]+/,' ')}...'",
-      }.reject{|k,v| v.nil? }
-    end
-  end
-
-  PrimitiveType.class_eval do
-    def inspect
-      "#<#{self.class.name} #{name}>"
-    end
-  end
-
-  NamedType.class_eval do
-    private
-    def inspect_hsh
-      super.merge( :namespace => @namespace )
-    end
-  end
-
-  RecordType.class_eval do
-    private
-    def inspect_hsh
-      super.merge( :fields  => (fields||[]).inject({}){|h,f| h[f.name] = ((f.type.present? && f.is_reference?) ? f.type.name : f.type) ; h }.inspect )
-    end
-  end
-
-  EnumType.class_eval do
-    private
-    def inspect_hsh
-      super.merge( :symbols => symbols.inspect )
-    end
-  end
-
-  FixedType.class_eval do
-    private
-    def inspect_hsh
-      super.merge( :size    => size.inspect )
-    end
-  end
-
-  ArrayType.class_eval do
-    private
-    def inspect_hsh
-      super.merge( :items   => items.inspect )
-    end
-  end
-
-  MapType.class_eval do
-    private
-    def inspect_hsh
-      super.merge( :values  => values.inspect )
-    end
-  end
-
-end
-

data/lib/icss/code_asset.rb

@@ -1,16 +0,0 @@
-module Icss
-  class CodeAsset
-    include Receiver
-    include Receiver::ActsAsHash
-
-    rcvr_accessor :name,      String
-    rcvr_accessor :location,  String
-
-    def to_hash()
-      { :name => name, :location => location}
-    end
-
-    def to_json() to_hash.to_json ; end
-
-  end
-end

data/lib/icss/core_ext.rb

@@ -1,9 +0,0 @@
-require 'gorillib/object/blank'
-require 'gorillib/string/inflections'
-require 'gorillib/string/constantize'
-require 'gorillib/array/compact_blank'
-require 'gorillib/array/extract_options'
-require 'gorillib/hash/compact'
-require 'gorillib/hash/keys'
-require 'gorillib/hash/tree_merge'
-require 'gorillib/metaprogramming/class_attribute'

data/lib/icss/data_asset.rb

@@ -1,22 +0,0 @@
-module Icss
-  class DataAsset
-    include Receiver
-    include Receiver::ActsAsHash
-
-    rcvr_accessor :name,      String
-    rcvr_accessor :location,  String
-    #overriding ruby's deprecated but still present type attr on objects
-    attr_accessor :type
-    rcvr_accessor :type,      String
-    rcvr_accessor :doc,       String
-
-    def named? nm
-      name == nm
-    end
-
-    def to_hash()
-      { :name => name, :location => location, :type => type, :doc => doc }
-    end
-    def to_json() to_hash.to_json ; end
-  end
-end

data/lib/icss/old.rb

@@ -1,96 +0,0 @@
-module Icss
-  Protocol.class_eval do
-
-    #
-    # Returns the asset hash with the passed in asset_name
-    #
-    def asset_for_name nm
-      warn "asset_for_name obsolete, please rewrite"
-      data_assets.find{|asset| asset.named?(nm) }
-    end
-
-    #
-    # Returns the full type for the passed in asset hash
-    #
-    def type_for_asset asset
-      warn "type_for_asset obsolete, please rewrite"
-      # types.find{|type| type.name == asset['type']}
-      raise 'use asset.type_obj'
-    end
-
-    #
-    # Given an asset name, returns the the record it points to
-    #
-    def type_for_asset_name asset_name
-      warn "type_for_asset_name obsolete, please rewrite"
-      asset = asset_for_name(asset_name)
-      type_for_asset(asset)
-    end
-
-    #
-    # Given an asset name, return the name of the type it points to
-    #
-    def type_name_for_asset_name asset_name
-      warn "type_name_for_asset_name obsolete, please rewrite"
-      asset = asset_for_name(asset_name)
-      asset['type']
-    end
-
-    #
-    # Return the avro record with the given name
-    #
-    def type_for_name type_name
-      warn "type_for_name obsolete, please rewrite"
-      # types.find{|record| record.name == type_name}
-      Icss::Type.find(type_name)
-    end
-
-    #
-    # Fetch the avro fields for a named data asset
-    #
-    def fields_for_asset asset_name
-      warn "fields_for_asset obsolete, please rewrite"
-      asset      = asset_for_name(asset_name)
-      asset_type = type_for_asset(asset)
-      asset_type.fields
-    end
-
-    #
-    # Fetch the locations on disk of each data asset. WARNING: Assuming relative paths
-    #
-    def location_for_asset asset_name
-      warn "location_for_asset obsolete, please rewrite"
-      asset = asset_for_name(asset_name)
-      File.join(dirname, asset['location'])
-    end
-
-    #
-    # Return the index of the named field for the named type. Returns (nil) if field
-    # does not exist
-    #
-    def index_of_fieldname asset_name, field_name
-      warn "index_of_fieldname obsolete, please rewrite"
-      type = type_for_asset_name(asset_name)
-      type.index_of_fieldname(field_name)
-    end
-
-    AVRO_PIG_MAPPING = {
-      'string' => 'chararray',
-      'int'    => 'int',
-      'long'   => 'long',
-      'float'  => 'float',
-      'double' => 'double',
-      'bytes'  => 'bytearray',
-      'fixed'  => 'bytearray'
-    }
-
-    #
-    # Add pig fields to a passed in array of avro fields
-    #
-    def augment_with_pig_fields fields
-      warn "augment_with_pig_fields obsolete, please rewrite"
-      fields.map{|field| field.body['pig_type'] = AVRO_PIG_MAPPING[field.type]; field }
-    end
-  end
-
-end

data/lib/icss/protocol_set.rb

@@ -1,48 +0,0 @@
-# you must require 'icss/protocol_set' explicitly to use it.
-
-module Icss
-  #
-  # Holds a set of icss protocols, with helper methods to load them from a
-  # directory tree, to merge in a protocol set yaml file, and so forth
-  #
-  class ProtocolSet
-    attr_accessor :protocols
-
-    def initialize
-      self.protocols = {}
-    end
-
-
-    def register pr
-      if protocols[pr.fullname]
-        protocols[pr.fullname].tree_merge!(pr)
-      else
-        protocols[pr.fullname] = pr
-      end
-    end
-
-    # load and register the protocols in the given filenames
-    def load_protocols *icss_filenames
-      icss_filenames = icss_filenames.flatten.compact
-      icss_filenames.each do |icss_filename|
-        register Icss::Protocol.receive_from_file(icss_filename)
-      end
-    end
-
-    # load and register the set of protocols in the given yaml file.
-    # it must be a hash with element 'protocol_set', holding an array of
-    # protocol hashes.
-    #
-    #   protocol_set:
-    #     - namespace: "..."
-    #       protocol:  "..."
-    def load_protocol_set protocol_set_filename
-      protocol_set_hsh = YAML.load(File.open(protocol_set_filename))
-      protocol_set_hsh['protocol_set'].each do |hsh|
-        register Icss::Protocol.receive(hsh)
-      end
-    end
-  end
-end
-
-

data/lib/icss/sample_message_call.rb

@@ -1,142 +0,0 @@
-module Icss
-  #
-  # Holds a sample call for a message and its expected response
-  #
-  # You may define the request parameters using an array of parameters
-  # or with the corresponding URL it would render to.
-  #
-  # This file also decorates Icss::Message and Icss::Protocol with helper methods for sample calls.
-  #
-  class SampleMessageCall
-    include Receiver
-    include Receiver::ActsAsHash
-    rcvr_accessor :name,              String
-    rcvr_accessor :doc,               String
-    rcvr_accessor :request,           Array, :default => []
-    rcvr_accessor :response,          Object  # a hash suitable for populating the message's @response@ type
-    attr_accessor :raw_response               # the raw http response from fetching
-    rcvr_accessor :error,             String
-    rcvr_accessor :url,               String
-    attr_accessor :message
-
-    # The URL implied by the given hostname and the sample request parameters.
-    #
-    # @param [String] hostname  The hostname or hostname:port to include in the URL
-    # @param [Hash]   extra_query_params A hash of extra params to in
-    #
-    # The URI expects string values in the hash used to build the query -- if
-    # calling #to_s on a field won't do what you want, clobber the value beforehand.
-    #
-    def full_url hostname, extra_query_params={}
-      host, port = hostname.split(':', 2)
-      u = Addressable::URI.new(:host => host, :port => port, :path => self.path, :scheme => 'http')
-      u.query_values = query_hash(extra_query_params)
-      u
-    end
-
-    def query_hash extra_query_params={}
-      hsh = (@url.present? ? @url.query_values : request.first.to_hash) rescue {}
-      hsh = hsh.merge extra_query_params
-      hsh.each{|k,v| hsh[k] = v.to_s }
-      hsh
-    end
-
-    def path
-      ((@url && @url.path).present? ? @url.path : "/#{message.path}" )
-    end
-
-    # @param [String, Addressable::URI]
-    #   the URL can be fully-qualified (htttp://api.infochimps.com/this/that?the=other) or relative (this/that?the=other)
-    #   and the path must match that of the message.
-    #
-    def url= new_url
-      if new_url.is_a?(String)
-        unless new_url.include?('?') then warn "sample request url should have a '?' introducing its query parameters: {#{new_url}}" ; end
-        new_url = Addressable::URI.parse(new_url)
-      end
-      @url = new_url
-    end
-
-    # Whips up the class implied by the ICSS type of this message's response,
-    # and populates it using the response hash.
-    def response_obj
-      return if response.blank?
-      klass = message.response.ruby_klass
-      klass.receive(response.compact_blank!)
-    end
-
-    # retrieve the response from the given host, storing it in response.  this
-    # catches all server errors and constructs a dummy response hash if the call
-    # fails.
-    def fetch_response! hostname="", extra_query_params={}
-      self.raw_response = fetch_raw_response( full_url(hostname, extra_query_params) )
-      begin
-        resp_hsh = JSON.load(raw_response.body)
-      rescue StandardError => e
-        warn ["  error parsing response: #{e}"].join("\n")
-        self.response = nil
-        self.error    = "JsonParseError"
-        return
-      end
-      if raw_response.code == 200
-        self.response = resp_hsh
-        self.error    = nil
-      else
-        self.response = nil
-        self.error    = resp_hsh["error"]
-      end
-    end
-
-  private
-
-    def fetch_raw_response full_url
-      RestClient.get(full_url.to_s) do |response, request, result|
-        response
-      end
-    end
-  end
-end
-
-class Icss::Message
-  rcvr_accessor :samples, Array, :of => Icss::SampleMessageCall, :default => []
-end
-
-class Icss::Protocol
-
-  #
-  # a hash for dumping to file:
-  # @example: from the whole thing, would dump only this:
-  #
-  #     namespace: util.time
-  #     protocol: chronic
-  #     messages:
-  #       parse:
-  #         samples:
-  #           - url:            "?now=5%3A06%3A07%202010-08-08&time_str=Yesterday"
-  #             response:       { "time": "2010-08-07 05:06:07 UTC", "epoch_seconds": 1281225967 }
-  #
-  def message_samples_hash
-    hsh = { :namespace => namespace, :protocol => protocol, :messages => {} }
-    messages.each do |msg_name, msg|
-      hsh[:messages][msg_name] = { :samples => [] }
-      msg.samples.each do |sample_req|
-        sample_hsh = {
-          :name     => sample_req.name,
-          :doc      => sample_req.doc,
-        }
-        if sample_req.response.present?
-        then sample_hsh[:response] =  sample_req.response
-        else sample_hsh[:error]    =  sample_req.error
-        end
-        if sample_req.url.present?
-        then sample_hsh[:url]      = sample_req.url.to_s
-        else sample_hsh[:request]  = sample_req.request
-        end
-        sample_hsh.compact_blank!
-        hsh[:messages][msg_name][:samples] << sample_hsh
-      end
-    end
-    return hsh
-  end
-
-end