roar 1.0.2 → 1.1.1

data/test/integration/json_collection_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+require 'roar/json/collection'
+require 'roar/client'
+
+class JsonCollectionTest < MiniTest::Spec
+  class Band < OpenStruct; end
+
+  class BandRepresenter < Roar::Decorator
+    include Roar::JSON
+
+    property :name
+    property :label
+  end
+
+  class BandsRepresenter < Roar::Decorator
+    include Roar::JSON::Collection
+    include Roar::Client
+
+    items extend: BandRepresenter, class: Band
+  end
+
+  class Bands < Array
+    include Roar::JSON::Collection
+  end
+
+  let(:bands) { Bands.new }
+
+  # "[{\"name\":\"Slayer\",\"label\":\"Canadian Maple\"},{\"name\":\"Nirvana\",\"label\":\"Sub Pop\"}])"
+  it 'fetches lonely collection of existing bands' do
+    BandsRepresenter.new(bands).get(uri: 'http://localhost:4567/bands', as: 'application/json')
+    bands.size.must_equal(2)
+    bands[0].name.must_equal('Slayer')
+  end
+end

data/test/{net_http_transport_test.rb → integration/net_http_transport_test.rb}

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'integration/runner'
 require 'roar/transport/net_http'
 
 class NetHTTPTransportTest < MiniTest::Spec

data/test/integration/runner.rb

@@ -1,6 +1,5 @@
 require "integration/band_representer"
-# require 'sinatra/runner' # TODO: merge that into sinatra-contrib.
-require 'lib/runner'
+require 'sinatra/runner'
 
 class ServerRunner < Sinatra::Runner
   def app_file
@@ -46,4 +45,4 @@ rescue Exception => e
   ssl_runner.kill
 
   raise e
-end
+end

data/test/integration/server.rb

@@ -55,6 +55,12 @@ post "/bands" do
   status 201
 end
 
+get '/bands' do
+  [OpenStruct.new(:name => "Slayer", :label => "Canadian Maple"),
+   OpenStruct.new(:name => "Nirvana", :label => "Sub Pop")]
+    .extend(Integration::BandRepresenter.for_collection).to_json
+end
+
 put "/bands/strungout" do
   # DISCUSS: as long as we don't agree on what to return in PUT/PATCH, let's return an updated document.
   body consume_band.to_json

data/test/json_representer_test.rb

@@ -61,7 +61,7 @@ class JsonRepresenterTest < MiniTest::Spec
 
       it "accepts :include and :exclude" do
         @order.from_json('{"id":1}', :exclude => [:id])
-        assert_equal nil, @order.id
+        assert_nil @order.id
       end
     end
 
@@ -74,32 +74,6 @@ class JsonRepresenterTest < MiniTest::Spec
   end
 end
 
-# test the generic roar+json HyperlinkRepresenter
-class JsonHyperlinkRepresenterTest
-  describe "API" do
-    before do
-      @link = Roar::Hypermedia::Hyperlink.new.extend(Roar::JSON::HyperlinkRepresenter).from_json(
-        '{"rel":"self", "href":"http://roar.apotomo.de", "media":"web"}')
-    end
-
-    it "responds to #rel" do
-      assert_equal "self", @link.rel
-    end
-
-    it "responds to #href" do
-      assert_equal "http://roar.apotomo.de", @link.href
-    end
-
-    it "responds to #media" do
-      assert_equal "web", @link.media
-    end
-
-    it "responds to #to_json" do
-      assert_equal "{\"rel\":\"self\",\"href\":\"http://roar.apotomo.de\",\"media\":\"web\"}", @link.to_json
-    end
-  end
-end
-
 class JsonHypermediaTest
   describe "Hypermedia API" do
     before do
@@ -119,7 +93,7 @@ class JsonHypermediaTest
     end
 
     it "responds to #links" do
-      @r.links.must_equal nil
+      @r.links.must_equal({})
     end
 
     it "extracts links from JSON" do
@@ -146,4 +120,3 @@ class JsonHypermediaTest
 
   end
 end
-

data/test/lonely_test.rb

@@ -4,6 +4,5 @@ require "roar/json/collection"
 require "roar/json/hash"
 
 class LonelyCollectionTest < MiniTest::Spec
-  it { Roar::JSON::Collection.must_equal Representable::JSON::Collection }
   it { Roar::JSON::Hash.must_equal Representable::JSON::Hash }
-end
+end

data/test/ssl_client_certs_test.rb

@@ -57,7 +57,7 @@ class SslClientCertsTest < MiniTest::Spec
 
           describe "when a pem file has been provided with the request options" do
 
-            let(:pem_file) { File.expand_path("test/fixtures/sample.pem", Roar.root) }
+            let(:pem_file) { File.expand_path("test/fixtures/sample.pem", File.expand_path('../..', __FILE__)) }
 
             let(:pem) { File.read(pem_file) }
             let(:cert) { OpenSSL::X509::Certificate.new(pem) }

data/test/test_helper.rb

@@ -1,9 +1,15 @@
+# require "pry"
 require 'minitest/autorun'
 require 'ostruct'
 
 require 'roar/representer'
 require 'roar/http_verbs'
-require 'roar/json/hal'
+
+require "roar/json"
+require "roar/json/hal"
+
+require "representable/debug"
+require "pp"
 
 module AttributesConstructor  # TODO: remove me.
   def initialize(attrs={})
@@ -26,13 +32,22 @@ end
 require "test_xml/mini_test"
 require "roar/xml"
 
-require "integration/runner"
 
 MiniTest::Spec.class_eval do
   def link(options)
     Roar::Hypermedia::Hyperlink.new(options)
   end
 
+  def self.decorator_for(modules=[Roar::JSON, Roar::Hypermedia], &block)
+    let(:decorator_class) do
+      Class.new(Roar::Decorator) do
+        include *modules.reverse
+
+        instance_eval(&block)
+      end
+    end
+  end
+
   def self.representer_for(modules=[Roar::JSON, Roar::Hypermedia], &block)
     let (:rpr) do
       Module.new do
@@ -42,6 +57,9 @@ MiniTest::Spec.class_eval do
       end
     end
   end
+  def representer
+    rpr # TODO: unify with representable.
+  end
 
   def self.representer!(*args, &block)
     representer_for(*args, &block)
@@ -57,4 +75,4 @@ Roar::Hypermedia::Hyperlink.class_eval do
   def ==(b)
     @attrs == b.instance_variable_get(:@attrs)
   end
-end
+end

data/test/xml_representer_test.rb

@@ -1,7 +1,8 @@
 require 'test_helper'
+require 'roar/decorator'
 
 class XMLRepresenterFunctionalTest < MiniTest::Spec
-  module OrderRepresenter
+  class OrderRepresenter < Roar::Decorator
     include Roar::XML
 
     property :id
@@ -11,10 +12,10 @@ class XMLRepresenterFunctionalTest < MiniTest::Spec
   Order = Struct.new(:id, :items)
 
   describe "#to_xml" do
-    let (:order) { Order.new(1).extend(OrderRepresenter) }
+    let (:order) { OrderRepresenter.new(Order.new(1)) }
 
     # empty model
-    it { Order.new.extend(OrderRepresenter).to_xml.must_equal_xml "<order/>" }
+    it { OrderRepresenter.new(Order.new).to_xml.must_equal_xml "<order/>" }
 
     # populated model
     it { order.to_xml.must_equal_xml "<order><id>1</id></order>" }
@@ -30,7 +31,7 @@ class XMLRepresenterFunctionalTest < MiniTest::Spec
   end
 
   describe "#from_xml" do
-    let (:order) { Order.new.extend(OrderRepresenter) }
+    let (:order) { OrderRepresenter.new(Order.new) }
 
     # parses
     it { order.from_xml("<order><id>1</id></order>").id.must_equal "1" }
@@ -39,7 +40,7 @@ class XMLRepresenterFunctionalTest < MiniTest::Spec
     it { order.deserialize("<order><id>1</id></order>").id.must_equal "1" }
 
     # accepts options
-    it { order.from_xml("<order><id>1</id></order>", exclude: [:id]).id.must_equal nil }
+    it { order.from_xml("<order><id>1</id></order>", exclude: [:id]).id.must_be_nil }
   end
 end
 

metadata

@@ -1,49 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: roar
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.1
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.1
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test_xml
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.4.2
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.4.2
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,9 +144,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".travis.yml"
 - CHANGES.markdown
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.markdown
@@ -160,11 +156,6 @@ files:
 - TODO.markdown
 - examples/example.rb
 - examples/example_server.rb
-- gemfiles/Gemfile.representable-1.7
-- gemfiles/Gemfile.representable-1.8
-- gemfiles/Gemfile.representable-2.0
-- gemfiles/Gemfile.representable-2.1
-- gemfiles/Gemfile.representable-head
 - lib/roar.rb
 - lib/roar/client.rb
 - lib/roar/coercion.rb
@@ -173,10 +164,8 @@ files:
 - lib/roar/hypermedia.rb
 - lib/roar/json.rb
 - lib/roar/json/collection.rb
-- lib/roar/json/collection_json.rb
 - lib/roar/json/hal.rb
 - lib/roar/json/hash.rb
-- lib/roar/json/json_api.rb
 - lib/roar/representer.rb
 - lib/roar/transport/faraday.rb
 - lib/roar/transport/net_http.rb
@@ -186,31 +175,28 @@ files:
 - roar.gemspec
 - test/client_test.rb
 - test/coercion_feature_test.rb
-- test/collection_json_test.rb
-- test/decorator_client_test.rb
 - test/decorator_test.rb
-- test/faraday_http_transport_test.rb
 - test/fixtures/sample.pem
 - test/hal_json_test.rb
-- test/hal_links_test.rb
-- test/http_verbs_test.rb
 - test/hypermedia_feature_test.rb
 - test/hypermedia_test.rb
 - test/integration/Gemfile
 - test/integration/band_representer.rb
+- test/integration/decorator_client_test.rb
+- test/integration/faraday_http_transport_test.rb
+- test/integration/http_verbs_test.rb
+- test/integration/json_collection_test.rb
+- test/integration/net_http_transport_test.rb
 - test/integration/runner.rb
 - test/integration/server.rb
 - test/integration/ssl_server.rb
-- test/json_api_test.rb
 - test/json_representer_test.rb
-- test/lib/runner.rb
 - test/lonely_test.rb
-- test/net_http_transport_test.rb
 - test/representer_test.rb
 - test/ssl_client_certs_test.rb
 - test/test_helper.rb
 - test/xml_representer_test.rb
-homepage: http://rubygems.org/gems/roar
+homepage: http://trailblazer.to/gems/roar
 licenses:
 - MIT
 metadata: {}
@@ -222,17 +208,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Parse and render REST API documents using representers.
 test_files: []
-has_rdoc: 

data/gemfiles/Gemfile.representable-1.7

@@ -1,6 +0,0 @@
-source "http://rubygems.org"
-
-gemspec path: '../'
-
-gem 'representable', '~> 1.7.0'
-gem 'sinatra-contrib', github: 'apotonick/sinatra-contrib', branch: 'runner'

data/gemfiles/Gemfile.representable-1.8

@@ -1,6 +0,0 @@
-source "http://rubygems.org"
-
-gemspec path: '../'
-
-gem 'representable', '~> 1.8.0'
-gem 'sinatra-contrib', github: 'apotonick/sinatra-contrib', branch: 'runner'

data/gemfiles/Gemfile.representable-2.0

@@ -1,5 +0,0 @@
-source "http://rubygems.org"
-
-gemspec path: '../'
-
-gem 'representable', '~> 2.0.0'

data/gemfiles/Gemfile.representable-2.1

@@ -1,5 +0,0 @@
-source "http://rubygems.org"
-
-gemspec path: '../'
-
-gem 'representable', '~> 2.1.5'

data/gemfiles/Gemfile.representable-head

@@ -1,6 +0,0 @@
-source "http://rubygems.org"
-
-gemspec path: '../'
-
-gem 'representable', github: 'apotonick/representable'
-gem 'sinatra-contrib', github: 'apotonick/sinatra-contrib', branch: 'runner'

data/lib/roar/json/collection_json.rb

@@ -1,208 +0,0 @@
-module Roar::JSON
-  # Implementation of the Collection+JSON media format, http://amundsen.com/media-types/collection/format/
-  #
-  # When clients want to add or update an item the collection's filled out template is POSTed or PUT. You can parse that using the
-  # +SongCollectionRepresenter::template_representer+ module.
-  #
-  #   Song.new.extend(SongCollectionRepresenter.template_representer).from_json("{template: ...")
-  module CollectionJSON
-    def self.included(base)
-      base.class_eval do
-        include Roar::Representer
-        include Roar::JSON
-        include Roar::Hypermedia
-
-        extend ClassMethods
-
-        self.representation_wrap= :collection # FIXME: move outside of this block for inheritance!
-
-        property :__template, :as => :template, :extend => lambda {|*| representable_attrs.collection_representers[:template] }, :class => Array
-        def __template
-          OpenStruct.new  # TODO: handle preset values.
-        end
-
-        collection :queries, :extend => Roar::JSON::HyperlinkRepresenter, :class => lambda { |fragment,*| ::Hash }
-        def queries
-          compile_links_for(representable_attrs.collection_representers[:queries].link_configs)
-        end
-        def queries=(v)
-        end
-
-
-        def items
-          self
-        end
-        def items=(v)
-          replace(v)
-        end
-
-        property :__version, :as => :version
-        def __version
-          representable_attrs.collection_representers[:version]
-        end
-
-        property :__href, :as => :href
-        def __href
-          compile_links_for(representable_attrs.collection_representers[:href].link_configs).first.href
-        end
-
-
-
-        include ClientMethods
-      end
-    end
-
-    module ClassMethods
-      module PropertyWithRenderNil
-        def property(name, options={})
-          super(name, options.merge!(:render_nil => true))
-        end
-      end
-
-      # TODO: provide automatic copying from the ItemRepresenter here.
-      def template(&block)
-        mod = representable_attrs.collection_representers[:object_template] = Module.new do
-          include Roar::JSON
-          include Roar::JSON::CollectionJSON::DataMethods
-
-          extend PropertyWithRenderNil
-
-          module_exec(&block)
-
-          #self.representation_wrap = :template
-          def from_hash(hash, *args)  # overridden in :template representer.
-            super(hash["template"])
-          end
-        end
-
-        representable_attrs.collection_representers[:template] = Module.new do
-          include Roar::JSON
-          include mod
-
-          #self.representation_wrap = false
-
-          # DISCUSS: currently we skip real deserialization here and just store the :data hash.
-          def from_hash(hash, *args)
-            replace(hash["data"])
-          end
-        end
-      end
-      def template_representer
-        representable_attrs.collection_representers[:object_template]
-      end
-
-      def queries(&block)
-        mod = representable_attrs.collection_representers[:queries] = Module.new do
-          include Roar::JSON
-          include Roar::Hypermedia
-
-          module_exec(&block)
-
-          def to_hash(*)
-            hash = super
-            hash["links"] # TODO: make it easier to render collection of links.
-          end
-        end
-      end
-
-      def items(options={}, &block)
-        collection :items, { :extend => lambda {|*| representable_attrs.collection_representers[:items] } }.merge!(options)
-
-        mod = representable_attrs.collection_representers[:items] = Module.new do
-          include Roar::JSON
-          include Roar::Hypermedia
-          include Roar::JSON::CollectionJSON::DataMethods
-          extend SharedClassMethodsBullshit
-
-          module_exec(&block)
-
-          # TODO: share with main module!
-          property :__href, :as => :href
-          def __href
-            compile_links_for(representable_attrs.collection_representers[:href].link_configs).first.href
-          end
-          def __href=(v)
-            @__href = Roar::Hypermedia::Hyperlink.new(:href => v)
-          end
-          def href
-            @__href
-          end
-        end
-      end
-
-      def version(v)
-        representable_attrs.collection_representers[:version] = v
-      end
-
-      module SharedClassMethodsBullshit
-        def href(&block)
-          mod = representable_attrs.collection_representers[:href] = Module.new do
-            include Roar::JSON
-            include Roar::Hypermedia
-
-
-            link(:href, &block)
-          end
-        end
-
-        def representable_attrs
-          super.tap do |attrs|
-            attrs.instance_eval do # FIXME: of course, this is WIP.
-              def collection_representers
-                @collection_representers ||= {}
-              end
-            end
-          end
-        end
-      end
-      include SharedClassMethodsBullshit
-    end
-
-    module DataMethods
-      def to_hash(*)
-        hash = super.tap do |hsh|
-          data = []
-          hsh.keys.each do |n|
-            next if ["href", "links"].include?(n)
-
-            v = hsh.delete(n.to_s)
-            data << {:name => n, :value => v} # TODO: get :prompt from Definition.
-          end
-          hsh[:data] = data
-        end
-      end
-
-      def from_hash(hash, *args)
-        data = {}
-        hash.delete("data").collect do |item|
-          data[item["name"]] = item["value"]
-        end
-        super(hash.merge!(data))
-      end
-    end
-
-    module ClientMethods
-      def __version=(v)
-        @__version = v
-      end
-      def version
-        @__version
-      end
-
-      def __href=(v)
-        @__href = Roar::Hypermedia::Hyperlink.new(:href => v)
-      end
-      def href
-        @__href
-      end
-
-      def __template=(v)
-        @__template = v
-      end
-      # DISCUSS: this might return a Template instance, soon.
-      def template
-        @__template
-      end
-    end
-  end
-end