RubyGems - gom-client - Versions diffs - 0.0.2 - Mend

gom-client 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

checksums.yaml +7 -0
data/.gitignore +22 -0
data/.travis.yml +17 -0
data/Gemfile +2 -0
data/Guardfile +8 -0
data/README.md +146 -0
data/Rakefile +2 -0
data/gom-client-ruby.gemspec +36 -0
data/lib/gom/client/version.rb +6 -0
data/lib/gom/client.rb +226 -0
data/spec/fixtures/vcr_cassettes/127_0_0_1_3000.yml +4469 -0
data/spec/fixtures/vcr_cassettes/gom_dev_artcom_de.yml +243 -0
data/spec/lib/gom/client/version_spec.rb +8 -0
data/spec/lib/gom/client_spec.rb +306 -0
data/spec/spec_helper.rb +43 -0
metadata +173 -0

data/spec/fixtures/vcr_cassettes/gom_dev_artcom_de.yml ADDED Viewed

@@ -0,0 +1,243 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://gom.dev.artcom.de/tests/1
+    body:
+      encoding: US-ASCII
+      string: <node/>
+    headers:
+      Content-Type:
+      - application/xml
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 303
+      message: See Other
+    headers:
+      Date:
+      - Tue, 25 Jun 2013 15:16:44 GMT
+      Server:
+      - Apache/2.2.16 (Debian)
+      X-Powered-By:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.19
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - POST, GET, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Max-Age:
+      - '86400'
+      Access-Control-Allow-Headers:
+      - X-Requested-With, X-HTTP-Method-Override, Content-Type, Accept, X-Http-Method-Override
+      Access-Control-Expose-Headers:
+      - Location, Content-Length
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - no-cache
+      X-Request-Id:
+      - a8edde73641c86168d4d61eb75bbc920
+      X-Runtime:
+      - '0.004594'
+      X-Rack-Cache:
+      - invalidate, pass
+      Location:
+      - http://gom.dev.artcom.de/tests/1/58ddce3a-9bd4-4d7a-9416-469fda0f6541
+      Status:
+      - '303'
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '135'
+      Content-Type:
+      - text/html; charset=utf-8
+    body:
+      encoding: US-ASCII
+      string: <html><body>You are being <a href="http://gom.dev.artcom.de/tests/1/58ddce3a-9bd4-4d7a-9416-469fda0f6541">redirected</a>.</body></html>
+    http_version:
+  recorded_at: Tue, 25 Jun 2013 14:56:53 GMT
+- request:
+    method: get
+    uri: http://gom.dev.artcom.de/tests/1/58ddce3a-9bd4-4d7a-9416-469fda0f6541
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 25 Jun 2013 15:16:44 GMT
+      Server:
+      - Apache/2.2.16 (Debian)
+      X-Powered-By:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.19
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - POST, GET, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Max-Age:
+      - '86400'
+      Access-Control-Allow-Headers:
+      - X-Requested-With, X-HTTP-Method-Override, Content-Type, Accept, X-Http-Method-Override
+      Access-Control-Expose-Headers:
+      - Location, Content-Length
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"a429961940b70f2c84aeaf795fa72122"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 88c9ff41af2dc7505c191419b2ae94db
+      X-Runtime:
+      - '0.002257'
+      X-Rack-Cache:
+      - miss
+      Status:
+      - '200'
+      Content-Length:
+      - '193'
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"node\": {\n    \"uri\": \"/tests/1/58ddce3a-9bd4-4d7a-9416-469fda0f6541\",\n
+        \   \"mtime\": \"2013-06-25T17:16:44+02:00\",\n    \"ctime\": \"2013-06-25T17:16:44+02:00\",\n
+        \   \"entries\": [\n      \n    ]\n  }\n}"
+    http_version:
+  recorded_at: Tue, 25 Jun 2013 14:56:53 GMT
+- request:
+    method: post
+    uri: http://gom.dev.artcom.de/tests/2
+    body:
+      encoding: US-ASCII
+      string: <node><attribute name='x'>u</attribute><attribute name='a'>23</attribute></node>
+    headers:
+      Content-Type:
+      - application/xml
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 303
+      message: See Other
+    headers:
+      Date:
+      - Tue, 25 Jun 2013 15:16:44 GMT
+      Server:
+      - Apache/2.2.16 (Debian)
+      X-Powered-By:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.19
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - POST, GET, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Max-Age:
+      - '86400'
+      Access-Control-Allow-Headers:
+      - X-Requested-With, X-HTTP-Method-Override, Content-Type, Accept, X-Http-Method-Override
+      Access-Control-Expose-Headers:
+      - Location, Content-Length
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - no-cache
+      X-Request-Id:
+      - 9a5376ef2153701f9827fee6075e6f5d
+      X-Runtime:
+      - '0.005069'
+      X-Rack-Cache:
+      - invalidate, pass
+      Location:
+      - http://gom.dev.artcom.de/tests/2/994d460d-1e45-48fd-9b43-90069ba49dce
+      Status:
+      - '303'
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '135'
+      Content-Type:
+      - text/html; charset=utf-8
+    body:
+      encoding: US-ASCII
+      string: <html><body>You are being <a href="http://gom.dev.artcom.de/tests/2/994d460d-1e45-48fd-9b43-90069ba49dce">redirected</a>.</body></html>
+    http_version:
+  recorded_at: Tue, 25 Jun 2013 14:56:53 GMT
+- request:
+    method: get
+    uri: http://gom.dev.artcom.de/tests/2/994d460d-1e45-48fd-9b43-90069ba49dce
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 25 Jun 2013 15:16:44 GMT
+      Server:
+      - Apache/2.2.16 (Debian)
+      X-Powered-By:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.19
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - POST, GET, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Max-Age:
+      - '86400'
+      Access-Control-Allow-Headers:
+      - X-Requested-With, X-HTTP-Method-Override, Content-Type, Accept, X-Http-Method-Override
+      Access-Control-Expose-Headers:
+      - Location, Content-Length
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"2728e0d11d84ba0f39b99860defc063c"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 343a7e53632116d872b3591f89eb444f
+      X-Runtime:
+      - '0.002261'
+      X-Rack-Cache:
+      - miss
+      Status:
+      - '200'
+      Content-Length:
+      - '193'
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"node\": {\n    \"uri\": \"/tests/2/994d460d-1e45-48fd-9b43-90069ba49dce\",\n
+        \   \"mtime\": \"2013-06-25T17:16:44+02:00\",\n    \"ctime\": \"2013-06-25T17:16:44+02:00\",\n
+        \   \"entries\": [\n      \n    ]\n  }\n}"
+    http_version:
+  recorded_at: Tue, 25 Jun 2013 14:56:53 GMT
+recorded_with: VCR 2.5.0

data/spec/lib/gom/client/version_spec.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'spec_helper'
+describe Gom::Client::VERSION do
+  it 'defines a VERSION' do
+    Gom::Client::VERSION.should be_kind_of(String)
+    Gom::Client::VERSION.should match(/\d\.\d\.\d/)
+  end
+end

data/spec/lib/gom/client_spec.rb ADDED Viewed

@@ -0,0 +1,306 @@
+require 'spec_helper'
+describe Gom::Client do
+  it 'exists' do
+    Gom::Client.should be_kind_of(Class)
+  end
+  context 'VCR cassette' do
+    #let(:gom)     { Gom::Client.new('http://gom.dev.artcom.de') }
+    let(:gom)     { Gom::Client.new('http://127.0.0.1:3000') }
+    #let(:prefix)  { gom.create!("/tests", {}) }
+    #let(:prefix)  { "/tests/08ec4b58-38b3-44ac-9ea9-62b42a62b061" }
+    before(:all) {
+     VCR.insert_cassette('127.0.0.1:3000', :record => :new_episodes)
+     # VCR.insert_cassette('gom.dev.artcom.de', :record => :new_episodes)
+    }
+    after(:all) {
+     VCR.eject_cassette
+    }
+    it 'creates and retrieves new node with no attributes' do
+      (uri = gom.create!("/tests/1", {})).should match(%r(/tests/1/\w+))
+      (hash = gom.retrieve uri).should be_kind_of(Hash)
+      (node = hash[:node]).should be_kind_of(Hash)
+      node[:uri].should eq(uri)
+      node[:entries].should eq([])
+    end
+    it 'creates and retrieves new node with some attributes' do
+      values = {:x => :u, :a => 23}
+      (uri = gom.create!("/tests/2", values)).should match(%r(/tests/2/\w+))
+      (hash = gom.retrieve uri).should be_kind_of(Hash)
+      (node = hash[:node]).should be_kind_of(Hash)
+      node[:uri].should eq(uri)
+      node[:entries].size.should be(2)
+      (hash = gom.retrieve "#{uri}:x").should be_kind_of(Hash)
+      hash[:attribute].should be_kind_of(Hash)
+      hash[:attribute][:value].should eq('u')
+      (hash = gom.retrieve "#{uri}:a").should be_kind_of(Hash)
+      hash[:attribute].should be_kind_of(Hash)
+      hash[:attribute][:value].should eq('23')
+    end
+    context 'with parent node' do
+      let(:nuri) { uniq_node_uri }
+      before(:each) { gom.update nuri }
+      it 'updates node with attributes' do
+        values = { "foo1" => "val1", "foo2" => "val2" }
+        (h = gom.update nuri, values).should be_kind_of(Hash)
+        h[:status].should eq(200)
+      end
+    end
+    it 'updates and retrieves attributes' do
+      uri = uniq_attr_uri
+      val = 'some text'
+      (gom.update uri, val).should eq(val)
+      (hash = gom.retrieve uri).should be_kind_of(Hash)
+      hash[:attribute].should be
+      hash[:attribute][:value].should eq(val)
+    end
+    it 'updates attribute containing ampersand' do
+      uri = uniq_attr_uri
+      val = 'Hallo & Ciao'
+      (gom.update uri, val).should eq(val)
+      (hash = gom.retrieve uri).should be_kind_of(Hash)
+      hash[:attribute].should be
+      hash[:attribute][:value].should eq(val)
+    end
+    it 'updates existing attribute to empty value' do
+      uri = uniq_attr_uri
+      gom.update(uri, "something")
+      gom.update uri, ""
+      (hash = gom.retrieve uri).should be_kind_of(Hash)
+      hash[:attribute].should be
+      hash[:attribute][:value].should eq('')
+    end
+    it 'updates new attribute to empty value' do
+      uri = uniq_attr_uri
+      gom.update(uri, '')
+      (hash = gom.retrieve uri).should be_kind_of(Hash)
+      hash[:attribute].should be
+      hash[:attribute][:value].should eq('')
+    end
+    it 'raises a 404 on retrieval of non-existing nodes' do
+      expect { gom.retrieve! "/no/such/node" }.to raise_error(
+        Gom::HttpError, %r(404 Not Found\s+while GETting /no/such/node)
+      )
+    end
+    context 'destroying things' do
+      let(:nuri) { uniq_node_uri }
+      let(:auri) { "#{nuri}:foo" }
+      let(:val) { "wello horld!" }
+      before(:each) { (gom.update auri, val).should eq(val) }
+      it 'destroys attributes' do
+        expect{gom.destroy auri}.to_not raise_error
+        gom.retrieve(auri).should be(nil)
+        expect { gom.retrieve!(auri) }.to raise_error(
+          Gom::HttpError, %r(404 Not Found\s+while GETting #{auri})
+        )
+      end
+      it 'destroys nodes' do
+        expect{gom.destroy nuri}.to_not raise_error
+        gom.retrieve(nuri).should be(nil)
+        expect { gom.retrieve!(nuri) }.to raise_error(
+          Gom::HttpError, %r(404 Not Found\s+while GETting #{nuri})
+        )
+        expect { gom.retrieve!(auri) }.to raise_error(
+          Gom::HttpError, %r(404 Not Found\s+while GETting #{auri})
+        )
+      end
+      it 'destroys non-existing node' do
+        expect { gom.destroy!(nuri) }.to_not raise_error
+      end
+      it 'destroys non-existing attribute' do
+        expect { gom.destroy!(auri) }.to_not raise_error
+      end
+    end
+    context 'running server side scripts' do
+      it 'raises on script AND path over-specified request' do
+        expect {
+          gom.run_script(:script => "something", :path  => "something else")
+        }.to raise_error(
+          ArgumentError, %r(must not provide script AND path)
+        )
+      end
+      it 'raises on script NOR path under-specified request' do
+        expect { gom.run_script }.to raise_error(
+          ArgumentError, %r(must provide script OR path)
+        )
+      end
+      context 'posted script' do
+        it 'runs simple posted script' do
+          rc = gom.run_script(:script => '"hello"')
+          rc.body.should eq('hello')
+          rc.code.should eq('200')
+        end
+        it 'passes parameter from request to the script' do
+          rc = gom.run_script(script: 'params.test', :params => {test: 'p1'})
+          rc.body.should eq('p1')
+          rc.code.should eq('200')
+        end
+        it 'passes multiple parameter to script' do
+          rc = gom.run_script(script: <<-JS, params: {p1: 'p1', p2: 'p2'})
+            params.p1 + ':' + params.p2
+          JS
+          rc.body.should eq('p1:p2')
+          rc.code.should eq('200')
+        end
+        it 'raises error on broken scripts' do
+          expect { gom.run_script script: 'intentional_error' }.to raise_error(
+            Gom::HttpError,
+            /400 Bad Request\s+.+intentional_error is not defined/m
+          )
+        end
+      end
+      context 'stored scripts' do
+        let(:script_uri) { uniq_attr_uri }
+        it 'runs a simple stored script' do
+          gom.update(script_uri, '"hello"')
+          rc = gom.run_script(path: script_uri)
+          rc.body.should eq('hello')
+          rc.code.should eq('200')
+        end
+        it 'passes parameter from request to the script' do
+          gom.update(script_uri, 'params.p1')
+          rc = gom.run_script(path: script_uri, :params => {p1: 'p1'})
+          rc.body.should eq('p1')
+          rc.code.should eq('200')
+        end
+        it 'passes multiple parameter to script' do
+          gom.update(script_uri, "params.p1 + ':' + params.p2")
+          rc = gom.run_script(path: script_uri, params: {p1: 'p1', p2: 'p2'})
+          rc.body.should eq('p1:p2')
+          rc.code.should eq('200')
+        end
+      end
+    end
+    context 'observer registrations' do
+      let(:cb_url) { 'http://localhost:4042/notification' }
+      it 'raises on no args at all' do
+        expect { gom.register_observer }.to raise_error(
+          ArgumentError, /callback_url must not be nil/
+        )
+      end
+      it 'raises on missing target node argument' do
+        expect { gom.register_observer(callback_url: cb_url) }.to raise_error(
+          ArgumentError, /node must not be nil/
+        )
+      end
+      it 'raises on invalid format' do
+        args = { callback_url: cb_url, node: '/some/node', format: 'Excel' }
+        expect { gom.register_observer(args) }.to raise_error(
+          ArgumentError, /invalid format: '#{args[:format]}'/
+        )
+      end
+      context 'anonymous oberserver' do
+        let(:target_uri) { uniq_node_uri }
+        it 'registers with node and callback' do
+          obs = gom.register_observer(node: target_uri, callback_url: cb_url)
+          obs.should match %r(/gom/observer#{target_uri}/\..+)
+          gom.retrieve_val("#{obs}:observed_uri").should eq(target_uri)
+          gom.retrieve_val("#{obs}:callback_url").should eq(cb_url)
+          gom.retrieve_val("#{obs}:accept").should eq("application/json")
+          gom.retrieve("#{obs}:operations").should be_nil
+          gom.retrieve("#{obs}:uri_regexp").should be_nil
+          gom.retrieve("#{obs}:condition_script").should be_nil
+          expect { gom.destroy obs }.to_not raise_error
+        end
+        it 'registers with filters, node and callback' do
+          obs = gom.register_observer(
+            node: target_uri, callback_url: cb_url, filters: {
+              'operations' => 'update,create',
+              'uri_regexp' => '*',
+              'condition_script' => '1 === 1;'
+            }
+          )
+          obs.should match %r(/gom/observer#{target_uri}/\..+)
+          gom.retrieve_val("#{obs}:observed_uri").should eq(target_uri)
+          gom.retrieve_val("#{obs}:callback_url").should eq(cb_url)
+          gom.retrieve_val("#{obs}:accept").should eq("application/json")
+          gom.retrieve_val("#{obs}:operations").should eq('update,create')
+          gom.retrieve_val("#{obs}:uri_regexp").should eq('*')
+          gom.retrieve_val("#{obs}:condition_script").should eq('1 === 1;')
+          expect { gom.destroy obs }.to_not raise_error
+        end
+      end # ~anonymous oberserver
+      context 'named observer' do
+        let(:target_uri) { uniq_node_uri }
+        let(:name) { "o1234" } ##{Time.now.tv_usec}" }
+        it 'supports filters' do
+          # with node, callback_url and filters
+          obs = gom.register_observer(
+            name: name, node: target_uri, callback_url: cb_url, filters: {
+              'operations' => 'update,create',
+              'uri_regexp' => '*',
+              'condition_script' => '1 === 1;'
+            }
+          )
+          obs.should eq("/gom/observer#{target_uri}/.#{name}")
+          gom.retrieve_val("#{obs}:observed_uri").should eq(target_uri)
+          gom.retrieve_val("#{obs}:callback_url").should eq(cb_url)
+          gom.retrieve_val("#{obs}:accept").should eq("application/json")
+          gom.retrieve_val("#{obs}:operations").should eq('update,create')
+          gom.retrieve_val("#{obs}:uri_regexp").should eq('*')
+          gom.retrieve_val("#{obs}:condition_script").should eq('1 === 1;')
+          expect { gom.destroy obs }.to_not raise_error
+          # register a second time with differnt name and changed optins to
+          # check whether the destroy clean-up really works
+          obs = gom.register_observer(
+            name: name, node: target_uri, callback_url: cb_url
+          )
+          obs.should eq("/gom/observer#{target_uri}/.#{name}")
+          gom.retrieve_val("#{obs}:observed_uri").should eq(target_uri)
+          gom.retrieve_val("#{obs}:callback_url").should eq(cb_url)
+          gom.retrieve_val("#{obs}:accept").should eq("application/json")
+          gom.retrieve_val("#{obs}:operations").should be(nil)
+          gom.retrieve_val("#{obs}:uri_regexp").should be(nil)
+          gom.retrieve_val("#{obs}:condition_script").should be(nil)
+          expect { gom.destroy obs }.to_not raise_error
+        end
+      end # ~ 'named observer'
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,43 @@
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'gom/client'
+require 'webmock/rspec'
+require 'vcr'
+module SpecHelpers
+  def next_uniq_seq_no
+    $__uniq_seq_no += 1
+  end
+  def uniq_node_uri(seq_no = next_uniq_seq_no)
+    #t = Time.now
+    #uri = "/some/random/node/n#{t.tv_sec}_#{t.tv_usec}"
+    uri = "/test/node/n#{seq_no}"
+  end
+  def uniq_attr_uri(seq_no = next_uniq_seq_no)
+    #t = Time.now
+    #uri = "/some/random/node/n#{t.tv_usec}:a#{t.tv_usec}"
+    uri = "/test/node/n#{seq_no}:a#{seq_no}"
+  end
+end
+RSpec.configure do |config|
+  $__uniq_seq_no = 1
+  config.include SpecHelpers
+  VCR.configure do |c|
+    basedir = File.dirname(__FILE__)
+    c.cassette_library_dir = File.join(basedir, 'fixtures', 'vcr_cassettes')
+    c.allow_http_connections_when_no_cassette = true
+    c.hook_into :webmock # or :fakeweb
+  end
+  config.before :each do
+  end
+  config.after :each do
+  end
+end