representors 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 302a3db2817d8fe764b0ee2649ce4771f1d57a40
+  data.tar.gz: 38cb226342fa028833cc3582a85832838e86820f
+SHA512:
+  metadata.gz: 65ed976754d9aac6f894b55b13e08aba69c18ec08a394efd000233552b4f95d6691c098c712592981ea2b7bca0b4a0e7a18d5e85646129750252a57919826c0b
+  data.tar.gz: 5d63a44bbd9e5419e431f4045e4c7b166343281b1029a5a3277ecc79dfc2340c0edb7d6fdba3a0cafb03e7660283b5589ada30dd40dee08a69b4841347f1632e

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# 0.0.5
+* Sync changes from the develop branch that had not been ported back to 0-0-stable (see PR #52 and PR #53)
+
+# 0.0.4
+* Updates and clean ups
+* Remove support of Ruby < 2.1
+
+# 0.0.3
+* Update to latest rspec and mutant
+* Implement URL templating
+* Change on behaviour of `Representor::Transition#templated_uri`. It only provides a template URL if the original URL followed the RFC 6570.
+
+# 0.0.2
+* Significant refactor of Builder to be non mutating
+* Includes Hale deserializer
+
+# 0.0.1
+* Initial Release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: .
+  specs:
+    representors (0.0.3)
+      addressable (~> 2.3)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    addressable (2.3.7)
+    anima (0.2.0)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.1)
+      equalizer (~> 0.0.8)
+    ast (2.0.0)
+    awesome_print (1.2.0)
+    byebug (3.2.0)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    equalizer (0.0.10)
+    ice_nine (0.11.1)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.8.2)
+    morpher (0.2.3)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      anima (~> 0.2.0)
+      ast (~> 2.0.0)
+      concord (~> 0.1.4)
+      equalizer (~> 0.0.9)
+      ice_nine (~> 0.11.0)
+      procto (~> 0.0.2)
+    multi_json (1.10.1)
+    mutant (0.7.8)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      anima (~> 0.2.0)
+      ast (~> 2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.2)
+      equalizer (~> 0.0.9)
+      ice_nine (~> 0.11.1)
+      memoizable (~> 0.4.2)
+      morpher (~> 0.2.3)
+      parallel (~> 1.3)
+      parser (~> 2.2.0.2)
+      procto (~> 0.0.2)
+      unparser (~> 0.2.2)
+    mutant-rspec (0.7.8)
+      mutant (~> 0.7.8)
+      rspec-core (>= 3.0.0, < 3.3.0)
+    parallel (1.4.1)
+    parser (2.2.0.3)
+      ast (>= 1.1, < 3.0)
+    procto (0.0.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-nav (0.2.3)
+      pry (~> 0.9.10)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    rake (10.4.2)
+    redcarpet (3.1.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.5.0)
+    thread_safe (0.3.5)
+    unparser (0.2.2)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.2.5)
+      equalizer (~> 0.0.9)
+      parser (~> 2.2.0.2)
+      procto (~> 0.0.2)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.2.0)
+  byebug (~> 3.2)
+  mutant (~> 0.7.8)
+  mutant-rspec (~> 0.7.8)
+  pry
+  pry-nav
+  pry-remote
+  redcarpet (~> 3.1.1)
+  representors!
+  rspec (~> 3.2)
+  simplecov (~> 0.8.2)
+  yard (~> 0.8.7)

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright © 2014 Medidata Solutions Worldwide
+
+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,28 @@
+# Representors
+
+A library to simplify Hypermedia message representation. It has the knowledge of Hypermedia media-types from the Ancients!
+
+This gem provides serializers and deserializers from/to known Hypermedia formats. It currently supports HAL and HALE.
+It also provides a Representor class to hold the information from hypermedia responses, this class provides method to access properties, transitions, etc.
+
+
+## Developing
+
+Write your tests, write your code and make sure all tests pass:
+```
+bundle exec rspec
+```
+
+Also, you can check your test coverage by running mutant on the classes you have worked on.
+For instance if you modified Representors::Representor, please execute:
+```
+MUTANT=true mutant --include lib --require representors --score 95 --use rspec Representors::Representor*
+```
+
+Reaching 100% mutant coverage is not feasible sometimes as they may be some false positives.
+But please investigate any missing coverage, as it may indicate an actual problem with the tests.
+
+
+## Copyright
+
+Copyright © 2016 Medidata Solutions Worldwide. See [LICENSE](LICENSE.md) for details.

data/Rakefile

@@ -0,0 +1,10 @@
+lib_dir = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib_dir)
+$LOAD_PATH.uniq!
+
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+require 'rake/clean'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/lib/representor_support/utilities.rb

@@ -0,0 +1,39 @@
+module RepresentorSupport
+  module Utilities
+
+    # Accepts a hash and returns a new hash with symbolized keys
+    def symbolize_keys(hash)
+      Hash[hash.map{|(k,v)| [k.to_sym,v]}]
+    end
+
+    # Will recursively deep dup an aribitrary set of nested hashes and arrays,
+    # but does not handle complex objects.  Also, this benchmarked *way* faster
+    # than the Marshal approach.
+    def deep_dup(obj)
+      if obj.is_a?(Hash)
+        result = {}
+        obj.each { |k,v| result[k] = deep_dup(v) }
+        result
+      elsif obj.is_a?(Array)
+        obj.map { |el| deep_dup(el) }
+      else
+        dup_or_self(obj)
+      end
+    end
+
+    # Unfortunately the best way to test if you can actually dup an object is to
+    # try, and handle the TypeError if not succesful.
+    def dup_or_self(obj)
+      begin
+        obj.dup
+      rescue TypeError
+        obj
+      end
+    end
+
+    def map_or_apply(proc, obj)
+      obj.is_a?(Array) ? obj.map { |sub| proc.(sub) } : proc.(obj)
+    end
+
+  end
+end

data/lib/representors.rb

@@ -0,0 +1,5 @@
+require 'representors/representor_hash'
+require 'representors/representor'
+require 'representors/representor_builder'
+
+require 'representors/serialization'

data/lib/representors/errors.rb

@@ -0,0 +1,7 @@
+module Representors
+  # General error when there is a problem with any deserialization.
+  class DeserializationError < StandardError; end
+
+  # Error to raise when the media-type we are trying to de/serialize is not known by this gem
+  class UnknownMediaTypeError < StandardError; end
+end

data/lib/representors/field.rb

@@ -0,0 +1,108 @@
+require 'yaml'
+require 'representors/options'
+require 'representor_support/utilities'
+module Representors
+  ##
+  # Manages the respresentation of hypermedia fields for different media-types.
+  class Field < String
+    include RepresentorSupport::Utilities
+
+    SIMPLE_METHODS = %w(name value default description field_type type data_type cardinality doc).map(&:to_sym)
+    DESCRIPTORS_KEY = :descriptors
+    ATTRIBUTE_FIELDS = 'attribute'
+    PARAMETER_FIELDS = 'href'
+    VALIDATORS_KEY = :validators
+    OPTIONS_KEY = :options
+    SCOPE_KEY = :scope
+    NAME_KEY = :name
+    DEFAULT_SCOPE = 'attribute'
+
+    # @example
+    #   hash =  {field_name: {field_property: property_name}}
+    #   Fields.new(hash)
+    # It must only have one key/vale pair where the value is a hash
+    # @param [Hash] the abstract representation of a Field
+    def initialize(field_hash)
+      name = field_hash.keys.first
+      field_hash[name] = symbolize_keys(field_hash[name])
+      @field_hash = field_hash[name].clone
+      @field_hash[NAME_KEY] = name
+      super value.to_s
+    end
+
+    SIMPLE_METHODS.each do |meth|
+      define_method(meth) { @field_hash[meth] }
+    end
+
+    # @return [String] representing the sort of field
+    def scope
+      @scope ||= @field_hash[SCOPE_KEY] || DEFAULT_SCOPE
+    end
+
+    # @return [Hash] The hash representation of the object
+    def to_hash
+      @to_hash ||= { @field_hash[NAME_KEY] => @field_hash.reject {|k,v| k == NAME_KEY } }
+    end
+
+    # @return [String] the yaml representation of the object
+    def to_yaml
+      @to_yaml ||= YAML.dump(to_hash)
+    end
+
+    # @return [Array] who's elements are all [Hash] objects
+    def validators
+      @validators ||= if @field_hash.has_key?(VALIDATORS_KEY)
+        @field_hash[VALIDATORS_KEY].map { |h| h.instance_of?(Symbol) ? {h => h} : h }
+      else
+        []
+      end
+    end
+
+    # @return [Array] who's elements are all Representors::Options objects
+    # TODO Not an array.  Its an Options, which should be an array?
+    def options
+      @options ||= Options.new(@field_hash[OPTIONS_KEY], name)
+    end
+
+    # @returns the value of the field
+    def call
+      value
+    end
+
+    # The Parameters (i.e. GET variables)
+    #
+    # @return [Array] who's elements are all <Crichton:Field> objects
+    def parameters
+      @parameters ||= get_field_by_type(PARAMETER_FIELDS)
+    end
+
+    # The Parameters (i.e. POST variables)
+    #
+    # @return [Array] who's elements are all <Crichton:Field> objects
+    def attributes
+      @attributes ||= get_field_by_type(ATTRIBUTE_FIELDS)
+    end
+    # The Parameters (i.e. GET variables)
+    #
+    # @return [Array] who's elements are all <Crichton:Field> objects
+    def descriptors
+      @descriptors ||= (attributes + parameters)
+    end
+
+    private
+
+    def filtered_fields(fields, scope)
+      fields.select { |field| field.scope == scope }
+    end
+
+    def descriptor_fields(hash)
+      hash[DESCRIPTORS_KEY].map { |k, v| Field.new({k => v }) }
+    end
+
+    def get_field_by_type(field_type)
+      fields = @field_hash.has_key?(DESCRIPTORS_KEY) ? descriptor_fields(@field_hash) : []
+      filtered_fields(fields, field_type)
+    end
+
+  end
+end

data/lib/representors/options.rb

@@ -0,0 +1,67 @@
+module Representors
+  ##
+  # Manages the respresentation of
+  # field options for a hypermedia message.
+  class Options
+    TYPE_KEYS = %w(external hash list)
+    LIST_TYPE = 'list'
+    EXTERNAL_TYPE = 'external'
+    HASH_TYPE = 'hash'
+    DEFAULT_TYPE = LIST_TYPE
+    ID_KEY = 'id'
+    ID_TEMPLATE = "%s_options"
+
+    # @param [Hash] the abstract representation of Field Options
+    def initialize(options_hash = {}, field_name = '')
+      @options_hash = options_hash || {}
+      @field_name = field_name
+    end
+
+    # @return [String] delineating the Options type
+    def type
+      @type ||= begin
+        type_keys = TYPE_KEYS.detect { |key| @options_hash.has_key?(key) }
+        type_keys || DEFAULT_TYPE
+      end
+    end
+
+    # @return [Bool] indicating whether the Options can be treated as a datalist
+    def datalist?
+      type == EXTERNAL_TYPE || @options_hash.has_key?(ID_KEY)
+    end
+
+    def empty?
+      to_hash.empty?
+    end
+
+    # @return [String] representing a unique id for the options
+    def id
+      @options_hash[ID_KEY] || ID_TEMPLATE % @field_name
+    end
+
+    # @return [Hash] version of the Options
+    def to_hash
+      type == LIST_TYPE ? Hash[(@options_hash[LIST_TYPE] || {}).map { |x| [x, x] }] : @options_hash[type]
+    end
+
+    # @return [Array] hash keys
+    def keys
+      to_hash.keys
+    end
+
+    # @return [Array] hash values
+    def values
+      to_hash.values
+    end
+
+    # @return [Array] version of the Options
+    def to_list
+      keys
+    end
+
+    def to_data
+      type == HASH_TYPE || type == EXTERNAL_TYPE ? to_hash : to_list
+    end
+
+  end
+end