contactology 0.0.1

data/spec/models/contactology/send_result_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Contactology::SendResult do
+  let(:result) { new_result }
+  subject { result }
+
+  context '#successful?' do
+    context 'when success is true' do
+      subject { result.successful? }
+
+      it { should be_true }
+    end
+
+    context 'when success is false' do
+      let(:result) { new_result default_options.merge('success' => false) }
+      subject { result.successful? }
+
+      it { should be_false }
+    end
+  end
+
+  context '#issues' do
+    context 'with no issues given' do
+      let(:result) { new_result 'success' => true }
+      subject { result.issues }
+
+      it { should be_kind_of Contactology::Issues }
+      it { should be_empty }
+      its(:score) { should == 0 }
+    end
+
+    context 'with issues given' do
+      let(:result) { new_result default_options.merge('issues' => {'issues' => [{'text' => 'Test Issue'}]}) }
+      subject { result.issues }
+
+      it 'contains the issues' do
+        subject.any? { |i| i.text == 'Test Issue' }.should be_true
+      end
+    end
+  end
+
+  context '#score' do
+    it 'returns the issues score' do
+      subject.score.should == default_options['issues']['score']
+    end
+  end
+
+
+  private
+
+
+  def default_options
+    {
+      'success' => true,
+      'issues' => {
+        'score' => 100,
+        'issues' => []
+      }
+    }
+  end
+
+  def new_result(options = default_options)
+    Contactology::SendResult.new options
+  end
+end

data/spec/models/contactology/stash_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Contactology::Stash do
+  class Stashie < Contactology::Stash
+    property :id
+    property :name, :from => :stashName
+    property :value, :required => true
+  end
+
+  context 'given defined properties' do
+    subject { new_stashie }
+
+    it { should be_instance_of Stashie }
+    its(:id) { should == 1 }
+    its(:name) { should == 'stashie' }
+    its(:value) { should == 2 }
+  end
+
+  context 'missing a required property' do
+    subject { new_stashie :id => 1 }
+
+    it 'raises an ArgumentError for the missing property' do
+      expect { subject }.to raise_error(ArgumentError, "The property 'value' is required for this Dash.")
+    end
+  end
+
+  context 'given fewer than the defined attributes' do
+    subject { new_stashie :value => 3.00 }
+
+    it { should be_instance_of Stashie }
+    its(:id) { should be_nil }
+    its(:name) { should be_nil }
+    its(:value) { should == 3 }
+  end
+
+  context 'given more than the defined attributes' do
+    subject { Stashie.new :value => 1, :unknown => true }
+
+    it { should be_instance_of Stashie }
+
+    it 'raises NoMethodError for undefined property' do
+      expect { subject.unknown }.to raise_error(NoMethodError)
+    end
+
+    its(:id) { should be_nil }
+    its(:name) { should be_nil }
+    its(:value) { should == 1 }
+  end
+
+
+  private
+
+
+  def default_attributes
+    {
+      :id => 1,
+      :name => 'stashie',
+      :value => 2.00
+    }
+  end
+
+  def new_stashie(attributes = default_attributes)
+    Stashie.new(attributes)
+  end
+end

data/spec/models/contactology/transactional_message_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Contactology::TransactionalMessage do
+  let(:message) { Factory.build_via_new :transactional_message }
+  subject { message }
+
+  context '#campaign' do
+    it 'is required' do
+      expect {
+        Contactology::TransactionalMessage.new Factory.attributes_for(:transactional_message).merge(:campaign => nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  context '#contact' do
+    it 'is required' do
+      expect {
+        Contactology::TransactionalMessage.new Factory.attributes_for(:transactional_message).merge(:contact => nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  context '#replacements' do
+    it 'is required' do
+      expect {
+        Contactology::TransactionalMessage.new Factory.attributes_for(:transactional_message).merge(:replacements => nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  context '#send_message' do
+    context 'when successful' do
+      use_vcr_cassette 'transactional_message/send_message/success'
+      let(:contact) { Factory :contact }
+      let(:campaign) { Factory :transactional_campaign }
+      let(:message) { Factory.build_via_new :transactional_message, :campaign => campaign, :contact => contact }
+      after(:each) { contact.destroy; campaign.destroy }
+
+      subject { message.send_message }
+
+      it { should be_true }
+    end
+
+    context 'when unsuccessful' do
+      use_vcr_cassette 'transactional_message/send_message/failure'
+      let(:contact) { Factory :contact }
+      let(:campaign) { Factory :transactional_campaign }
+      let(:message) { Factory.build_via_new :transactional_message, :campaign => campaign, :contact => contact }
+      before(:each) { campaign.destroy }
+      after(:each) { contact.destroy }
+
+      subject { message.send_message }
+
+      it { should be_false }
+    end
+  end
+
+  context '#source' do
+    it 'is required' do
+      expect {
+        Contactology::TransactionalMessage.new Factory.attributes_for(:transactional_message).merge(:source => nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/models/contactology_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Contactology do
+  maintain_contactology_configuration
+
+  let(:configuration) { Contactology.configuration }
+
+  context '.configuration' do
+    it 'yields a Contactology::Configuration instance' do
+      Contactology.configuration do |yielded|
+        yielded.should be_kind_of Contactology::Configuration
+      end
+    end
+
+    it 'yields the same configuration instance across multiple calls' do
+      Contactology.configuration do |config|
+        Contactology.configuration do |config2|
+          config.object_id.should == config2.object_id
+        end
+      end
+    end
+
+    it 'returns the configuration when queried' do
+      Contactology.configuration do |config|
+        Contactology.configuration.object_id.should == config.object_id
+      end
+    end
+
+    it 'may be explicitly overridden' do
+      configuration = Contactology::Configuration.new
+      expect {
+        Contactology.configuration = configuration
+      }.to change(Contactology, :configuration).to(configuration)
+    end
+
+    it 'raises an ArgumentError when set to a non-Configuration object' do
+      expect {
+        Contactology.configuration = 'bad'
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  context '.endpoint' do
+    it 'returns the configuration endpoint' do
+      Contactology.endpoint.should == configuration.endpoint
+    end
+
+    it 'overrides the configuration endpoint' do
+      expect {
+        Contactology.endpoint = 'https://example.local/'
+      }.to change(configuration, :endpoint).to('https://example.local/')
+    end
+  end
+
+  context '.key' do
+    it 'returns the configuration key' do
+      configuration.key = 'test'
+      Contactology.key.should == configuration.key
+    end
+
+    it 'overrides the configuration key' do
+      expect {
+        Contactology.key = 'testing'
+      }.to change(configuration, :key).to('testing')
+    end
+  end
+end

data/spec/requests/contacts_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe 'Contacts' do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default, :development)
+
+# Requires supporting files with custom matchers and macros, etc.,
+# in ./support/ and its subdirectories.
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each do |file|
+  require(file)
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/contactology.rb

@@ -0,0 +1,34 @@
+require 'pathname'
+
+path = Pathname.new(File.expand_path('../../contactology.yml', __FILE__))
+
+if path.exist?
+  begin
+    CONTACTOLOGY_CONFIGURATION = YAML.load_file(path)
+    Contactology.configure do |config|
+      config.key = CONTACTOLOGY_CONFIGURATION['key'] || abort("Contactology configuration file (#{path}) is missing the key value.")
+      config.endpoint = CONTACTOLOGY_CONFIGURATION['endpoint'] if CONTACTOLOGY_CONFIGURATION.has_key?('endpoint')
+    end
+  rescue NoMethodError
+    abort "Contactology configuration file (#{path}) is malformatted or unreadable."
+  end
+else
+  abort "Contactology test configuration (#{path}) not found."
+end
+
+module ConfigurationSpecHelpers
+  def maintain_contactology_configuration
+    before(:each) do
+      @_isolated_configuration = Contactology.configuration
+      Contactology.configuration = @_isolated_configuration.dup
+    end
+
+    after(:each) do
+      Contactology.configuration = @_isolated_configuration
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.extend ConfigurationSpecHelpers
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,19 @@
+Dir[File.expand_path('../../factories', __FILE__) + '/*.rb'].each do |factory|
+  require factory
+end
+
+def Factory.build_via_new(name, attributes = {})
+  attributes = Factory.attributes_for(name).merge(attributes)
+  klass = FactoryGirl.factory_by_name(name).build_class
+  klass.new(attributes)
+end
+
+##
+# Override the default Factory() create alias method to build the attributes
+# hash, then create them all though the new method. This gets around :required
+# attribute issues in Hashie objects.
+#
+def Factory(name, attributes = {})
+  Factory.build_via_new(name, attributes).save!
+end
+

data/spec/support/vcr.rb

@@ -0,0 +1,11 @@
+VCR.config do |config|
+  config.cassette_library_dir = File.expand_path('../../fixtures/net', __FILE__)
+  config.default_cassette_options = { :record => :none }
+  config.stub_with :webmock
+  config.filter_sensitive_data('%{API_KEY}') { CONTACTOLOGY_CONFIGURATION['key'] }
+  config.filter_sensitive_data('%{API_ENDPOINT}') { CONTACTOLOGY_CONFIGURATION['endpoint'] }
+end
+
+RSpec.configure do |config|
+  config.extend(VCR::RSpec::Macros)
+end

metadata

@@ -0,0 +1,282 @@
+--- !ruby/object:Gem::Specification 
+name: contactology
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nathaniel Bibler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: vcr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.5"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: infinity_test
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.2"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: watchr
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id008
+description: This library provides Ruby calls to interact with the Contactology email marketing API
+email: 
+- git@nathanielbibler.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .infinity_test
+- .rspec
+- .rvmrc
+- .watchr
+- Gemfile
+- Rakefile
+- contactology.gemspec
+- lib/contactology.rb
+- lib/contactology/api.rb
+- lib/contactology/basic_object.rb
+- lib/contactology/campaign.rb
+- lib/contactology/campaign/preview.rb
+- lib/contactology/campaigns.rb
+- lib/contactology/campaigns/standard.rb
+- lib/contactology/campaigns/transactional.rb
+- lib/contactology/configuration.rb
+- lib/contactology/contact.rb
+- lib/contactology/errors.rb
+- lib/contactology/issue.rb
+- lib/contactology/issues.rb
+- lib/contactology/list.rb
+- lib/contactology/list_proxy.rb
+- lib/contactology/parser.rb
+- lib/contactology/send_result.rb
+- lib/contactology/stash.rb
+- lib/contactology/transactional_message.rb
+- lib/contactology/version.rb
+- spec/factories/campaigns.rb
+- spec/factories/contacts.rb
+- spec/factories/issues.rb
+- spec/factories/lists.rb
+- spec/factories/transactional_messages.rb
+- spec/fixtures/net/campaign/destroy.yml
+- spec/fixtures/net/campaign/find/failure.yml
+- spec/fixtures/net/campaign/find/success.yml
+- spec/fixtures/net/campaign/find_by_name/failure.yml
+- spec/fixtures/net/campaign/find_by_name/success.yml
+- spec/fixtures/net/campaign/preview.yml
+- spec/fixtures/net/campaigns/standard/create/failure.yml
+- spec/fixtures/net/campaigns/standard/create/invalid.yml
+- spec/fixtures/net/campaigns/standard/create/success.yml
+- spec/fixtures/net/campaigns/standard/send_campaign/failure.yml
+- spec/fixtures/net/campaigns/standard/send_campaign/success.yml
+- spec/fixtures/net/campaigns/transactional/create/failure.yml
+- spec/fixtures/net/campaigns/transactional/create/success.yml
+- spec/fixtures/net/contact/active.yml
+- spec/fixtures/net/contact/change_email/success.yml
+- spec/fixtures/net/contact/change_email/unknown.yml
+- spec/fixtures/net/contact/create.yml
+- spec/fixtures/net/contact/destroy.yml
+- spec/fixtures/net/contact/find/active.yml
+- spec/fixtures/net/contact/find/suppressed.yml
+- spec/fixtures/net/contact/find/unknown.yml
+- spec/fixtures/net/contact/lists/empty.yml
+- spec/fixtures/net/contact/lists/full.yml
+- spec/fixtures/net/contact/lists/unknown.yml
+- spec/fixtures/net/contact/suppress.yml
+- spec/fixtures/net/list/all.yml
+- spec/fixtures/net/list/create.yml
+- spec/fixtures/net/list/destroy.yml
+- spec/fixtures/net/list/find/success.yml
+- spec/fixtures/net/list/find/unknown.yml
+- spec/fixtures/net/list/import/success.yml
+- spec/fixtures/net/list/subscribe/success.yml
+- spec/fixtures/net/list/unsubscribe/success.yml
+- spec/fixtures/net/transactional_message/send_message/failure.yml
+- spec/fixtures/net/transactional_message/send_message/success.yml
+- spec/models/contactology/api_spec.rb
+- spec/models/contactology/campaign_spec.rb
+- spec/models/contactology/campaigns/standard_spec.rb
+- spec/models/contactology/campaigns/transactional_spec.rb
+- spec/models/contactology/configuration_spec.rb
+- spec/models/contactology/contact_spec.rb
+- spec/models/contactology/issues_spec.rb
+- spec/models/contactology/list_spec.rb
+- spec/models/contactology/send_result_spec.rb
+- spec/models/contactology/stash_spec.rb
+- spec/models/contactology/transactional_message_spec.rb
+- spec/models/contactology_spec.rb
+- spec/requests/contacts_spec.rb
+- spec/spec_helper.rb
+- spec/support/contactology.rb
+- spec/support/factory_girl.rb
+- spec/support/vcr.rb
+homepage: https://github.com/nbibler/contactology
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A Ruby interface to the Contactology email marketing API
+test_files: 
+- spec/factories/campaigns.rb
+- spec/factories/contacts.rb
+- spec/factories/issues.rb
+- spec/factories/lists.rb
+- spec/factories/transactional_messages.rb
+- spec/fixtures/net/campaign/destroy.yml
+- spec/fixtures/net/campaign/find/failure.yml
+- spec/fixtures/net/campaign/find/success.yml
+- spec/fixtures/net/campaign/find_by_name/failure.yml
+- spec/fixtures/net/campaign/find_by_name/success.yml
+- spec/fixtures/net/campaign/preview.yml
+- spec/fixtures/net/campaigns/standard/create/failure.yml
+- spec/fixtures/net/campaigns/standard/create/invalid.yml
+- spec/fixtures/net/campaigns/standard/create/success.yml
+- spec/fixtures/net/campaigns/standard/send_campaign/failure.yml
+- spec/fixtures/net/campaigns/standard/send_campaign/success.yml
+- spec/fixtures/net/campaigns/transactional/create/failure.yml
+- spec/fixtures/net/campaigns/transactional/create/success.yml
+- spec/fixtures/net/contact/active.yml
+- spec/fixtures/net/contact/change_email/success.yml
+- spec/fixtures/net/contact/change_email/unknown.yml
+- spec/fixtures/net/contact/create.yml
+- spec/fixtures/net/contact/destroy.yml
+- spec/fixtures/net/contact/find/active.yml
+- spec/fixtures/net/contact/find/suppressed.yml
+- spec/fixtures/net/contact/find/unknown.yml
+- spec/fixtures/net/contact/lists/empty.yml
+- spec/fixtures/net/contact/lists/full.yml
+- spec/fixtures/net/contact/lists/unknown.yml
+- spec/fixtures/net/contact/suppress.yml
+- spec/fixtures/net/list/all.yml
+- spec/fixtures/net/list/create.yml
+- spec/fixtures/net/list/destroy.yml
+- spec/fixtures/net/list/find/success.yml
+- spec/fixtures/net/list/find/unknown.yml
+- spec/fixtures/net/list/import/success.yml
+- spec/fixtures/net/list/subscribe/success.yml
+- spec/fixtures/net/list/unsubscribe/success.yml
+- spec/fixtures/net/transactional_message/send_message/failure.yml
+- spec/fixtures/net/transactional_message/send_message/success.yml
+- spec/models/contactology/api_spec.rb
+- spec/models/contactology/campaign_spec.rb
+- spec/models/contactology/campaigns/standard_spec.rb
+- spec/models/contactology/campaigns/transactional_spec.rb
+- spec/models/contactology/configuration_spec.rb
+- spec/models/contactology/contact_spec.rb
+- spec/models/contactology/issues_spec.rb
+- spec/models/contactology/list_spec.rb
+- spec/models/contactology/send_result_spec.rb
+- spec/models/contactology/stash_spec.rb
+- spec/models/contactology/transactional_message_spec.rb
+- spec/models/contactology_spec.rb
+- spec/requests/contacts_spec.rb
+- spec/spec_helper.rb
+- spec/support/contactology.rb
+- spec/support/factory_girl.rb
+- spec/support/vcr.rb