essential 0.9.0

data/test/essential/messaging/transport_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class TransportTest < EssentialTest
+  include Essential::Messaging
+
+  def setup
+    @first = Transport.list.first
+  end
+
+  def test_retrieve
+    found = Transport.retrieve(@first.sid)
+
+    assert_equal found, @first
+  end
+
+  def test_list
+    all = Transport.list
+
+    all_sids = all.map(&:sid)
+
+    assert all_sids.include?(@first.sid)
+    assert_equal all_sids.size, all.size
+  end
+
+  def test_relations
+    mess = @first.messages
+    refute_equal 0, mess.size
+    assert mess.all? {|m| Message === m}
+
+    subs = @first.subscribers
+    refute_equal 0, subs.size
+    assert subs.all? {|s| Subscriber === s}
+
+    channel = @first.channel
+    assert_equal @first.channel_sid, channel.sid
+  end
+end

data/test/integration/alternate_authentication_test.rb

@@ -0,0 +1,128 @@
+require 'test_helper'
+
+class AlternateAuthenticationTest < EssentialTest
+  def setup
+    @account = Essential::Account.retrieve
+    @alt_account = Essential::Account.retrieve(
+      headers: {sid: 'eJ1WDpPBufJuDDYVO5xrKg', token: 'db72ed0fc101d65c5354834191d833e21a'}
+    )
+
+    refute_nil @alt_account, 'missing @alt_account: your dev setup needs help!'
+    refute_equal @account.sid, @alt_account.sid, '@account and @alt_account must be different'
+    refute_equal @account.token, @alt_account.token, '@account and @alt_account must be different'
+  end
+
+  def test_messages_account
+    evaluate_relations(obj: 'ac.messages',
+                       default: @account.messages,
+                       alterate: @alt_account.messages)
+
+    dm = Essential::Messaging::Message.list
+    am = Essential::Messaging::Message.list(
+      headers: {sid: @alt_account.sid, token: @alt_account.token}
+    )
+
+    evaluate_relations(obj: 'ac.messages', default: dm, alterate: am)
+  end
+
+  def test_messages_subscriber
+    dsub = @account.messages.first.subscriber
+    asub = @alt_account.messages.first.subscriber
+
+    evaluate_relations(obj: 'sub.messages', default: dsub.messages, alterate: asub.messages)
+  end
+
+  def test_messages_channel
+    dch = @account.messages.first.channel
+    ach = @alt_account.messages.first.channel
+
+    evaluate_relations(obj: 'ch.messages', default: dch.messages, alterate: ach.messages)
+  end
+
+  def test_messages_transport
+    dtr = @account.messages.first.transport
+    atr = @alt_account.messages.first.transport
+
+    evaluate_relations(obj: 'tr.messages', default: dtr.messages, alterate: atr.messages)
+  end
+
+  def test_channels_account
+    evaluate_relations(obj: 'ac.channels',
+                       default: @account.channels,
+                       alterate: @alt_account.channels)
+
+    alts = Essential::Messaging::Channel.list(
+      headers: {sid: @alt_account.sid, token: @alt_account.token}
+    )
+    evaluate_relations(obj: 'ac.channels',
+                       default: Essential::Messaging::Channel.list,
+                       alterate: alts)
+  end
+
+  def test_subscribers_account
+    evaluate_relations(obj: 'ac.subscribers',
+                       default: @account.subscribers,
+                       alterate: @alt_account.subscribers)
+
+    alts = Essential::Messaging::Subscriber.list(
+      headers: {sid: @alt_account.sid, token: @alt_account.token}
+    )
+    evaluate_relations(obj: 'ac.subscribers',
+                       default: Essential::Messaging::Subscriber.list,
+                       alterate: alts)
+  end
+
+  def test_subscribers_channel
+    dch = @account.subscribers.first.channel
+    ach = @alt_account.subscribers.first.channel
+
+    evaluate_relations(obj: 'ch.subscribers',
+                       default: dch.subscribers,
+                       alterate: ach.subscribers)
+  end
+
+  def test_subscribers_transport
+    dtr = @account.subscribers.first.transport
+    atr = @alt_account.subscribers.first.transport
+
+    evaluate_relations(obj: 'tr.subscribers',
+                       default: dtr.subscribers,
+                       alterate: atr.subscribers)
+  end
+
+  def test_transports_account
+    evaluate_relations(obj: 'ac.transports',
+                       default: @account.transports,
+                       alterate: @alt_account.transports)
+
+    alts = Essential::Messaging::Transport.list(
+      headers: {sid: @alt_account.sid, token: @alt_account.token}
+    )
+    evaluate_relations(obj: 'ac.transports',
+                       default: Essential::Messaging::Transport.list,
+                       alterate: alts)
+  end
+
+  def test_transports_channel
+    dch = @account.transports.first.channel
+    ach = @alt_account.transports.first.channel
+
+    evaluate_relations(obj: 'ch.transports',
+                       default: dch.transports,
+                       alterate: ach.transports)
+  end
+
+  protected
+
+  def evaluate_relations(obj:, default:, alterate:)
+    refute_equal 0, default.size, format('missing default %s: your dev setup needs help!', obj)
+    refute_equal 0, alterate.size, format('missing alterate %s: your dev setup needs help!', obj)
+
+    default = Set.new(default.map(&:sid))
+    alterate = Set.new(alterate.map(&:sid))
+
+    refute_equal default, alterate
+    assert_equal Set.new, (default & alterate), format('%s sids may not overlap', obj)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+require 'minitest/autorun'
+require 'essential'
+
+require 'securerandom'
+require 'set'
+
+if ENV.key?('ESSENTIAL_SID') && ENV.key?('ESSENTIAL_TOKEN')
+  $debug = false
+  Essential.api_base = ENV['ESSENTIAL_URL'] || 'http://127.0.0.1:3000'
+  Essential.sid = ENV['ESSENTIAL_SID']
+  Essential.token = ENV['ESSENTIAL_TOKEN']
+else
+  # TODO: # require 'webmock/minitest'
+  # mock all responses?
+end
+
+class EssentialTest < Minitest::Test
+
+  protected
+
+  def assert_error_with_params(*params, &_)
+    error = assert_raises Essential::APIError do
+      yield
+    end
+
+    refute_nil error.params, 'APIError must have params'
+
+    expected_params = Set.new(params.map(&:to_s))
+    actual_params   = Set.new(error.params.keys.map(&:to_s))
+
+    assert_equal expected_params, actual_params, 'APIError params must match exactly'
+  end
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: essential
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Brendan Ribera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: A GEM for interacting with the Essential.to service.
+email: brendan@madronavl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- essential.gemspec
+- lib/essential.rb
+- lib/essential/account.rb
+- lib/essential/client.rb
+- lib/essential/errors/api_error.rb
+- lib/essential/messaging/channel.rb
+- lib/essential/messaging/message.rb
+- lib/essential/messaging/property.rb
+- lib/essential/messaging/subscriber.rb
+- lib/essential/messaging/transport.rb
+- lib/essential/resource.rb
+- lib/essential/resource/attr_methods.rb
+- lib/essential/resource/attr_relations.rb
+- lib/essential/resource/create.rb
+- lib/essential/resource/delete.rb
+- lib/essential/resource/list.rb
+- lib/essential/resource/paginator_proxy.rb
+- lib/essential/resource/update.rb
+- lib/essential/version.rb
+- test/essential/account_test.rb
+- test/essential/messaging/channel_test.rb
+- test/essential/messaging/message_test.rb
+- test/essential/messaging/property_test.rb
+- test/essential/messaging/subscriber_test.rb
+- test/essential/messaging/transport_test.rb
+- test/integration/alternate_authentication_test.rb
+- test/test_helper.rb
+homepage: http://github.com/madrona-labs/essential-ruby
+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.1
+signing_key: 
+specification_version: 4
+summary: Essential Ruby Library
+test_files:
+- test/essential/account_test.rb
+- test/essential/messaging/channel_test.rb
+- test/essential/messaging/message_test.rb
+- test/essential/messaging/property_test.rb
+- test/essential/messaging/subscriber_test.rb
+- test/essential/messaging/transport_test.rb
+- test/integration/alternate_authentication_test.rb
+- test/test_helper.rb