RubyGems - connect_client - Versions diffs - 0.1.0 - Mend

connect_client 0.1.0

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 (23) hide show

checksums.yaml +7 -0
data/.gitignore +38 -0
data/Gemfile +3 -0
data/LICENSE +22 -0
data/README.md +45 -0
data/Rakefile +22 -0
data/connect_client.gemspec +25 -0
data/data/cacert.pem +3988 -0
data/lib/connect_client.rb +41 -0
data/lib/connect_client/client.rb +43 -0
data/lib/connect_client/configuration.rb +12 -0
data/lib/connect_client/event.rb +52 -0
data/lib/connect_client/event_push_response.rb +49 -0
data/lib/connect_client/http/event_endpoint.rb +137 -0
data/lib/connect_client/version.rb +3 -0
data/spec/connect_client/client_spec.rb +48 -0
data/spec/connect_client/configuration_spec.rb +55 -0
data/spec/connect_client/event_push_response_spec.rb +150 -0
data/spec/connect_client/event_spec.rb +47 -0
data/spec/connect_client/http/http_event_endpoint_spec.rb +121 -0
data/spec/connect_client/http/synchrony/event_endpoint_spec.rb +60 -0
data/spec/connect_client_spec.rb +25 -0
metadata +155 -0

data/spec/connect_client/event_push_response_spec.rb ADDED Viewed

@@ -0,0 +1,150 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'connect_client/event'
+require 'connect_client/event_push_response'
+describe ConnectClient::EventPushResponse do
+  before do
+    @json_content_type = 'application/json; charset=utf-8'
+    @sample_event = ConnectClient::Event.new({name: 'test'})
+    @sample_event_data = @sample_event.data
+  end
+  it "should be successful when status code is 201" do
+    body = ''
+    code = 201
+    event_response = ConnectClient::EventPushResponse.new code, @json_content_type, body, @sample_event
+    event_response.success?.must_equal true
+  end
+  it "should pass through string body if content type is not json" do
+    body = ''
+    code = 500
+    event_response = ConnectClient::EventPushResponse.new code, @json_content_type, body, @sample_event
+    event_response.success?.must_equal false
+  end
+  it "should not be successful when status code is 500" do
+    body = ''
+    code = 500
+    event_response = ConnectClient::EventPushResponse.new code, @json_content_type, body, @sample_event
+    event_response.success?.must_equal false
+  end
+  it "should not parse body that is not json content" do
+    content_type = 'text/html'
+    body = '<html><html>'
+    code = 500
+    event_response = ConnectClient::EventPushResponse.new code, content_type, body, @sample_event
+    event_response.data.must_equal body
+  end
+  it "should set status code even if body is not json content" do
+    content_type = 'text/html'
+    body = '<html><html>'
+    code = 500
+    event_response = ConnectClient::EventPushResponse.new code, content_type, body, @sample_event
+    event_response.http_status_code.must_equal '500'
+  end
+  it "should pass through error message in data" do
+    body = '{ "errorMessage": "something went wrong" }'
+    code = 500
+    event_response = ConnectClient::EventPushResponse.new code, @json_content_type, body, @sample_event
+    event_response.data[:errorMessage].must_equal 'something went wrong'
+  end
+  it "should pass back event in response when successful" do
+    body = ''
+    code = 200
+    event_response = ConnectClient::EventPushResponse.new code, @json_content_type, body, @sample_event
+    event_response.data[:event].must_be_same_as  @sample_event_data
+  end
+  it "should pass through original event with error" do
+    body = '{ "errorMessage": "something went wrong" }'
+    code = 500
+    event_response = ConnectClient::EventPushResponse.new code, @json_content_type, body, @sample_event
+    event_response.data[:event].must_be_same_as  @sample_event_data
+  end
+  it "should pass through success status under collection name for batch" do
+    body = %@
+      {
+        "collectionName": [{
+          "success": true
+        }]
+      }
+    @
+    code = 200
+    events = { :collectionName => [@sample_event] }
+    event_response = ConnectClient::EventPushResponse.new code, @json_content_type, body, events
+    event_response.data[:collectionName][0][:success].must_equal true
+  end
+  it "should pass through duplicate status under collection name for batch" do
+    body = %@
+      {
+        "collectionName": [{
+          "duplicate": true
+        }]
+      }
+    @
+    code = 200
+    events = { :collectionName => [@sample_event] }
+    event_response = ConnectClient::EventPushResponse.new code, @json_content_type, body, events
+    event_response.data[:collectionName][0][:duplicate].must_equal true
+  end
+  it "should show event under collection name for batch" do
+    body = %@
+      {
+        "collectionName": [{
+          "success": true
+        }]
+      }
+    @
+    code = 200
+    events = { :collectionName => [@sample_event] }
+    event_response = ConnectClient::EventPushResponse.new code, @json_content_type, body, events
+    event_response.data[:collectionName][0][:event].must_be_same_as @sample_event_data
+  end
+end

data/spec/connect_client/event_spec.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'connect_client/event'
+describe ConnectClient::Event do
+  it "should throw a validation exception if a property starts with tp_" do
+    connect_event = proc { ConnectClient::Event.new({tp_foo: 'bar'}) }.must_raise ConnectClient::EventDataValidationError
+  end
+  it "should supply an id if none present" do
+    connect_event = ConnectClient::Event.new({foo: 'bar'})
+    uuid_regex = /[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}/
+    connect_event.data[:id].must_match uuid_regex
+  end
+  it "should pass through id supplied" do
+    connect_event = ConnectClient::Event.new({id: :bar})
+    connect_event.data[:id].must_equal :bar
+  end
+  it "should supply timestamp if none present" do
+    iso_date = '2015-07-01T04:07:57Z'
+    a_time = Time.parse(iso_date);
+    Time.stub :now, a_time do
+      connect_event = ConnectClient::Event.new({foo: 'bar'})
+      connect_event.data[:timestamp].must_equal iso_date
+    end
+  end
+  it "should turn timestamp into iso string" do
+    iso_date = '2015-07-01T04:07:57Z'
+    a_time = Time.parse(iso_date);
+    connect_event = ConnectClient::Event.new({foo: 'bar', timestamp: a_time})
+    connect_event.data[:timestamp].must_equal iso_date
+  end
+  it "should pass through timestamp string if supplied" do
+    iso_date = '2015-07-01T04:07:57Z'
+    connect_event = ConnectClient::Event.new({foo: 'bar', timestamp: iso_date})
+    connect_event.data[:timestamp].must_equal iso_date
+  end
+end

data/spec/connect_client/http/http_event_endpoint_spec.rb ADDED Viewed

@@ -0,0 +1,121 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'connect_client/http/event_endpoint'
+require 'connect_client/event_push_response'
+require 'connect_client/event'
+require 'connect_client/configuration'
+require 'securerandom'
+describe ConnectClient::Http::EventEndpoint do
+  before do
+    @endpoint = ConnectClient::Http::EventEndpoint.new (ConnectClient::Configuration.new)
+    @async_endpoint = ConnectClient::Http::EventEndpoint.new (ConnectClient::Configuration.new '', '', true)
+    @sample_event_data = { id: SecureRandom.uuid, timestamp: Time.now.utc.iso8601, name: 'sample' }
+    @sample_event = ConnectClient::Event.new(@sample_event_data)
+    @sample_events_reponse = '{"sample": [{"success": true}]}'
+    @sample_collection = 'sample'
+    @sample_batch_data = { @sample_collection.to_sym => [@sample_event_data] }
+    @sample_batch = { @sample_collection.to_sym => [@sample_event] }
+  end
+  it "should get a push response back when pushing a single event to a collection" do
+    stub_request(:post, "https://api.getconnect.io/events/#{@sample_collection}").
+      with(:body => @sample_event_data, :headers => { 'Accept' => 'application/json' }).
+      to_return(:status => 200, :body => "", :headers => { 'Content-Type'=>'application/json' })
+    response = @endpoint.push @sample_collection, @sample_event
+    response.must_be_instance_of ConnectClient::EventPushResponse
+  end
+  it "should get push to overriden base_url" do
+    overriden_url_config = ConnectClient::Configuration.new '', '', false, 'https://whatever.test'
+    endpoint = ConnectClient::Http::EventEndpoint.new overriden_url_config
+    stub_request(:post, "https://whatever.test/events/#{@sample_collection}").
+      with(:body => @sample_event_data, :headers => { 'Accept' => 'application/json' }).
+      to_return(:status => 200, :body => "", :headers => { 'Content-Type'=>'application/json' })
+    response = endpoint.push @sample_collection, @sample_event
+    response.must_be_instance_of ConnectClient::EventPushResponse
+  end
+  it "should get push response for a non sucessful error code" do
+    overriden_url_config = ConnectClient::Configuration.new '', '', false, 'https://whatever.test'
+    endpoint = ConnectClient::Http::EventEndpoint.new overriden_url_config
+    stub_request(:post, "https://whatever.test/events/#{@sample_collection}").
+      with(:body => @sample_event_data, :headers => { 'Accept' => 'application/json' }).
+      to_return(:status => 500, :body => "", :headers => { 'Content-Type'=>'application/json' })
+    response = endpoint.push @sample_collection, @sample_event
+    response.http_status_code.to_s.must_equal '500'
+  end
+  it "should get a push response back when pushing batches" do
+    stub_request(:post, "https://api.getconnect.io/events").
+      with(:body => @sample_batch_data, :headers => { 'Accept' => 'application/json' }).
+      to_return(:status => 200, :body => @sample_events_reponse, :headers => { 'Content-Type'=>'application/json' })
+    response = @endpoint.push_batch @sample_batch
+    response.must_be_instance_of ConnectClient::EventPushResponse
+  end
+  it "should get a push response back when pushing a single event to a collection async" do
+    stub_request(:post, "https://api.getconnect.io/events/#{@sample_collection}").
+      with(:body => @sample_event_data, :headers => { 'Accept' => 'application/json' }).
+      to_return(:status => 200, :body => "", :headers => { 'Content-Type'=>'application/json' })
+    EM.run do
+      @async_endpoint.push(@sample_collection, @sample_event).response_received { |response|
+        begin
+          response.must_be_instance_of ConnectClient::EventPushResponse
+        ensure
+          EM.stop
+        end
+      }.error_occured { |error|
+        EM.stop
+        raise error
+      }
+    end
+  end
+  it "should get push response for a non sucessful error code async" do
+    stub_request(:post, "https://api.getconnect.io/events/#{@sample_collection}").
+      with(:body => @sample_event_data, :headers => { 'Accept' => 'application/json' }).
+      to_return(:status => 500, :body => "", :headers => { 'Content-Type'=>'application/json' })
+    EM.run do
+      @async_endpoint.push(@sample_collection, @sample_event).response_received { |response|
+        begin
+          response.http_status_code.to_s.must_equal '500'
+        ensure
+          EM.stop
+        end
+      }.error_occured { |error|
+        EM.stop
+        raise error
+      }
+    end
+  end
+  it "should get a push response back when pushing batches" do
+    stub_request(:post, "https://api.getconnect.io/events").
+      with(:body => @sample_batch_data, :headers => { 'Accept' => 'application/json' }).
+      to_return(:status => 200, :body => @sample_events_reponse, :headers => { 'Content-Type'=>'application/json' })
+    EM.run do
+      @async_endpoint.push_batch(@sample_batch).response_received { |response|
+        begin
+          response.must_be_instance_of ConnectClient::EventPushResponse
+        ensure
+          EM.stop
+        end
+      }.error_occured { |error|
+        EM.stop
+        raise error
+      }
+    end
+  end
+end

data/spec/connect_client/http/synchrony/event_endpoint_spec.rb ADDED Viewed

@@ -0,0 +1,60 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'connect_client/client'
+require 'connect_client/configuration'
+require 'connect_client/event_push_response'
+require 'securerandom'
+require 'em-synchrony'
+require 'em-synchrony/em-http'
+describe ConnectClient::Http::EventEndpoint, "Test with syncrony defined" do
+  before do
+    @async_endpoint = ConnectClient::Http::EventEndpoint.new (ConnectClient::Configuration.new '', '', true)
+    @sample_event_data = { id: SecureRandom.uuid, timestamp: Time.now.utc.iso8601, name: 'sample' }
+    @sample_event = ConnectClient::Event.new(@sample_event_data)
+    @sample_events_reponse = '{"sample": [{"success": true}]}'
+    @sample_collection = 'sample'
+    @sample_batch_data = { @sample_collection.to_sym => [@sample_event_data] }
+    @sample_batch = { @sample_collection.to_sym => [@sample_event] }
+  end
+  it "should get a push response back when pushing a single event to a collection" do
+    stub_request(:post, "https://api.getconnect.io/events/#{@sample_collection}").
+      with(:body => @sample_event_data).
+      to_return(:status => 200, :body => "", :headers => { 'Content-Type'=>'application/json' })
+    response = nil
+    EM.synchrony do
+      response = @async_endpoint.push @sample_collection, @sample_event
+      EM.stop
+    end
+    response.must_be_instance_of ConnectClient::EventPushResponse
+  end
+  it "should get push response for a non sucessful error code" do
+    stub_request(:post, "https://api.getconnect.io/events/#{@sample_collection}").
+      with(:body => @sample_event_data).
+      to_return(:status => 500, :body => "", :headers => { 'Content-Type'=>'application/json' })
+    response = nil
+    EM.synchrony do
+      response = @async_endpoint.push @sample_collection, @sample_event
+      EM.stop
+    end
+    response.http_status_code.to_s.must_equal '500'
+  end
+  it "should get a push response back when pushing batches" do
+    stub_request(:post, "https://api.getconnect.io/events").
+      with(:body => @sample_batch_data).
+      to_return(:status => 200, :body => @sample_events_reponse, :headers => { 'Content-Type'=>'application/json' })
+    response = nil
+    EM.synchrony do
+      response = @async_endpoint.push_batch @sample_batch
+      EM.stop
+    end
+    response.must_be_instance_of ConnectClient::EventPushResponse
+  end
+end

data/spec/connect_client_spec.rb ADDED Viewed

@@ -0,0 +1,25 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'connect_client/configuration'
+require 'connect_client'
+describe ConnectClient do
+  before do
+    ConnectClient.reset
+  end
+  it "should throw a configuration error configuration has not been called" do
+    connect_event = proc { ConnectClient.push 'test', {} }.must_raise ConnectClient::UnconfiguredError
+  end
+  it "should respond to push" do
+    ConnectClient.configure {}
+    ConnectClient.respond_to?(:push).must_equal true
+  end
+  it "should support configuration via a block" do
+    ConnectClient.configure do |config|
+      config.must_be_instance_of ConnectClient::Configuration
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: connect_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Team Connect
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-synchrony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Connect SDK for interacting with the Connect API
+email: team@getconnect.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- connect_client.gemspec
+- data/cacert.pem
+- lib/connect_client.rb
+- lib/connect_client/client.rb
+- lib/connect_client/configuration.rb
+- lib/connect_client/event.rb
+- lib/connect_client/event_push_response.rb
+- lib/connect_client/http/event_endpoint.rb
+- lib/connect_client/version.rb
+- spec/connect_client/client_spec.rb
+- spec/connect_client/configuration_spec.rb
+- spec/connect_client/event_push_response_spec.rb
+- spec/connect_client/event_spec.rb
+- spec/connect_client/http/http_event_endpoint_spec.rb
+- spec/connect_client/http/synchrony/event_endpoint_spec.rb
+- spec/connect_client_spec.rb
+homepage: https://github.com/getconnect/connect_client-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
+specification_version: 4
+summary: Connect SDK
+test_files:
+- spec/connect_client/client_spec.rb
+- spec/connect_client/configuration_spec.rb
+- spec/connect_client/event_push_response_spec.rb
+- spec/connect_client/event_spec.rb
+- spec/connect_client/http/http_event_endpoint_spec.rb
+- spec/connect_client/http/synchrony/event_endpoint_spec.rb
+- spec/connect_client_spec.rb