apsis 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2FmNmYyMzg0YzA4ZjA2NmZkNTZiNzc5NzU2MDkxMjhhOTg4ODY2Mw==
+  data.tar.gz: !binary |-
+    NjM3ZGQ0ZWQwMTA1M2RlNGRlYzYyZWUzZTc4MjgyZWZkYmI4MjhmZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NmZmZWEyYzgyZDcxOTY3YzMyZGJmNDlmOTcwNjcwMTZlYTY4NDY3YmFhNTZi
+    OTQ2NjRhMDA5OThiZWVmZTYxZjA3ODA4ZTI5MjNkMDE5Y2M4Zjc0MTNmMWVl
+    MzI1YTY0MmFmMjQ1NjMzZTgzNGYwY2Y5MDI5NzhjZmE2ZmUxNDc=
+  data.tar.gz: !binary |-
+    OTQ5Mzg1MDU1NDdjMzZkMjhkZWY3MDA0NDI3MTU1OWJiNjA1MDU3YzIyMWUw
+    M2Y5NzQyODc2ODVhYzdlOWNlYmE4ZTg0NWY0YWJmOWE1YjUxOTliNmFhMTY4
+    ODFkMjgzZDI4YjhhNjE4MDE4OTU5MTI2MDk2MzhiNWNkYzI0ZWI=

data/.gitignore

@@ -3,6 +3,8 @@
 .bundle
 .config
 .yardoc
+.ruby-version
+bin
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -15,3 +17,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/bundle

data/README.md

@@ -27,7 +27,7 @@ variable (recommended) or provide it as an argument when you instantiate a new A
     # Note that APSIS is fussy about the capitalization of the keys.
     apsis.create_subscribers(123456, [
       { 'Email' => 'johndoe@example.com', 'Name' => 'John Doe' },
-      { 'Email' => 'janedoe@example.com', 'Name' => 'jane.doe@example.com' }
+      { 'Email' => 'janedoe@example.com', 'Name' => 'Jane Doe' }
     ])
 
 ## Contributing

data/Rakefile

@@ -1 +1,9 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+require 'bundler/setup';
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+Bundler.setup(:default, :development)
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/apsis.gemspec

@@ -9,8 +9,10 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Henrik Sjökvist"]
   gem.email         = ["henrik.sjokvist@gmail.com"]
   gem.description   = %q{A simple API wrapper for the APSIS mail marketing service.}
-  gem.summary       = %q{A simple API wrapper for the APSIS mail marketing service.}
+  gem.summary       = %q{A simple API wrapper for the APSIS mail marketing service. 
+                         This gem currently only supports adding subcribers to a mailing list.}
   gem.homepage      = "http://github.com/kollegorna/apsis-ruby"
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -20,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.rubyforge_project = "apsis"
 
   # Dependencies
-  # specify any dependencies here; for example:
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "vcr"
   gem.add_runtime_dependency     "faraday"
 end

data/lib/apsis.rb

@@ -24,7 +24,7 @@ class Apsis
     unless response.status == 200
       raise ApsisError.new("Apsis API Error: #{response.body} (status code #{response.status})")
     end
-    response.body
+    JSON.parse response.body
   end
 
   def create_subscribers(mailinglist_id, subscribers = [])

data/lib/apsis/version.rb

@@ -1,3 +1,3 @@
 class Apsis
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/apsis_spec.rb

@@ -0,0 +1,38 @@
+require 'vcr'
+require 'faraday'
+require_relative 'support/vcr'
+require_relative '../lib/apsis.rb'
+
+
+unless ENV['APSIS_API_KEY'] && ENV['APSIS_TEST_MAILING_LIST']
+  warn ["WARNING: You need to set the APSIS_API_KEY and APSIS_TEST_MAILING_LIST",
+    "environment variables or the calls to the APSIS API will be invalid."].join("\n")
+end
+
+describe "Apsis" do
+  it "adds a subscriber to a list" do
+    VCR.use_cassette('add_subscriber') do
+      api_key = ENV['APSIS_API_KEY']
+      mailing_list = ENV['APSIS_TEST_MAILING_LIST']
+      apsis = Apsis.new(api_key)
+      response = apsis.create_subscribers(mailing_list, [
+        { 'Email' => 'johndoe@example.com', 'Name' => 'John Doe' },
+        { 'Email' => 'janedoe@example.com', 'Name' => 'Jane Doe' }
+      ])
+      response['Code'].should eql 1
+    end
+  end
+
+  it "raises an exception when an error HTTP status code is returned" do
+    VCR.use_cassette('raise_exception') do
+      api_key = ENV['APSIS_API_KEY']
+      mailing_list = 'thisisnogood'
+      apsis = Apsis.new(api_key)
+      lambda {
+        apsis.create_subscribers(mailing_list, [
+        { 'Email' => 'johndoe@example.com', 'Name' => 'John Doe' },
+        { 'Email' => 'janedoe@example.com', 'Name' => 'Jane Doe' }
+      ])}.should raise_error(Apsis::ApsisError)
+    end
+  end
+end

data/spec/fixtures/vcr/add_subscriber.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://se.api.anpdm.com/v1/subscribers/mailinglist/<MAILING_LIST>/queue
+    body:
+      encoding: UTF-8
+      string: ! '[{"Email":"johndoe@example.com","Name":"John Doe"},{"Email":"janedoe@example.com","Name":"Jane
+        Doe"}]'
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - Faraday v0.8.6
+      Authorization:
+      - <KEY>
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      cache-control:
+      - private
+      content-length:
+      - '230'
+      content-type:
+      - application/json; charset=utf-8
+      server:
+      - Microsoft-IIS/7.0
+      date:
+      - Tue, 12 Mar 2013 15:10:06 GMT
+      connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"Code":1,"Message":"Creating subscribers will be handled shortly...","Result":{"OperationGuid":"9b087599-e26d-47f8-932b-03092fb91fd0","PollURL":"http:\/\/se.api.anpdm.com\/data\/9b087599-e26d-47f8-932b-03092fb91fd0_status.json"}}'
+    http_version: 
+  recorded_at: Tue, 12 Mar 2013 15:10:01 GMT
+recorded_with: VCR 2.4.0

data/spec/fixtures/vcr/raise_exception.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://se.api.anpdm.com/v1/subscribers/mailinglist/thisisnogood/queue
+    body:
+      encoding: UTF-8
+      string: ! '[{"Email":"johndoe@example.com","Name":"John Doe"},{"Email":"janedoe@example.com","Name":"Jane
+        Doe"}]'
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - Faraday v0.8.6
+      Authorization:
+      - <KEY>
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 400
+      message: 
+    headers:
+      cache-control:
+      - private
+      content-length:
+      - '74'
+      content-type:
+      - application/json; charset=utf-8
+      server:
+      - Microsoft-IIS/7.0
+      date:
+      - Tue, 12 Mar 2013 15:10:09 GMT
+      connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"Code":-2,"Message":"MailinglistId must be greater than 0","Result":null}'
+    http_version: 
+  recorded_at: Tue, 12 Mar 2013 15:10:04 GMT
+recorded_with: VCR 2.4.0

data/spec/support/vcr.rb

@@ -0,0 +1,9 @@
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr'
+  c.hook_into :faraday
+  c.filter_sensitive_data('<KEY>') do |interaction|
+    interaction.request.headers['Authorization'].first
+  end
+  c.filter_sensitive_data('<MAILING_LIST>') { ENV['APSIS_TEST_MAILING_LIST'] }
+end
+

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: apsis
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Henrik Sjökvist
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-13 00:00:00.000000000 Z
+date: 2013-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,20 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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
@@ -30,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -58,28 +67,37 @@ files:
 - apsis.gemspec
 - lib/apsis.rb
 - lib/apsis/version.rb
+- spec/apsis_spec.rb
+- spec/fixtures/vcr/add_subscriber.yml
+- spec/fixtures/vcr/raise_exception.yml
+- spec/support/vcr.rb
 homepage: http://github.com/kollegorna/apsis-ruby
-licenses: []
+licenses:
+- MIT
+metadata: {}
 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: apsis
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: A simple API wrapper for the APSIS mail marketing service.
-test_files: []
+specification_version: 4
+summary: A simple API wrapper for the APSIS mail marketing service.  This gem currently
+  only supports adding subcribers to a mailing list.
+test_files:
+- spec/apsis_spec.rb
+- spec/fixtures/vcr/add_subscriber.yml
+- spec/fixtures/vcr/raise_exception.yml
+- spec/support/vcr.rb