ct_sendyr 0.2.1 → 0.2.1.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sendyr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Carl Mercier
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Sendyr
+
+A Ruby interface for the wonderful e-mail newsletter application Sendy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sendyr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sendyr
+
+## Usage
+
+		Sendyr.configure do |c|
+			c.url     = 'http://my.sendy-install.com'
+			c.api_key = '1234567890'
+			# c.noop  = true  # You can use this to noop in dev and test environments
+		end
+
+		list_id = 1
+		client = Sendyr::Client.new(list_id)
+		client.subscribe(email: 'joe@example.org', name: 'Joe Smith', 'FirstName' => 'Joe')  # => true
+
+		client.subscription_status(email: 'joe@example.org') #  => :subscribed
+
+		client.active_subscriber_count  # => 1
+
+		client.unsubscribe(email: 'joe@example.org')  # => true
+
+		client.update_subscription('joe@example.org', email: 'newemail@example.com', name: 'Joe Smith', FirstName => 'Joe')  # => true
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/sendyr/client.rb

@@ -0,0 +1,153 @@
+require 'uri'
+
+module Sendyr
+	class Client
+		attr_reader :last_result, :api_key, :base_uri, :list_id
+
+		def initialize(list_id = nil)
+			@list_id     = list_id
+			@api_key     = Sendyr.configuration.api_key
+			@base_uri    = Sendyr.configuration.url
+			@noop        = Sendyr.configuration.noop || false
+		end
+
+		def subscribe(opts = {})
+			return noop if @noop
+
+			opts = {boolean: true, list: @list_id}.merge(opts)
+			raise_if_missing_arg([:email, :list], opts)
+
+			path   = '/subscribe'
+			result = post_to(path, opts)
+
+			if result.success? && %w(true 1).include?(clean_body(result))
+				respond_with_success(result)
+			else
+				respond_with_failure(result)
+			end
+		end
+
+		def unsubscribe(opts = {})
+			return noop if @noop
+
+			opts = {boolean: true, list: @list_id}.merge(opts)
+			raise_if_missing_arg([:email, :list], opts)
+
+			path   = '/unsubscribe'
+			result = post_to(path, opts)
+
+			if result.success? && %w(true 1).include?(clean_body(result))
+				respond_with_success(result)
+			else
+				respond_with_failure(result)
+			end
+		end
+
+		def subscription_status(opts = {})
+			return noop if @noop
+
+			opts = {api_key: @api_key, list_id: @list_id}.merge(opts)
+			raise_if_missing_arg([:api_key, :email, :list_id, :api_key], opts)
+
+			path   = '/api/subscribers/subscription-status.php'
+			result = post_to(path, opts)
+
+			success_messages = { "subscribed"   => :subscribed,
+													 "unsubscribed" => :unsubscribed,
+													 "unconfirmed"  => :unconfirmed,
+													 "bounced"      => :bounced,
+													 "soft bounced" => :soft_bounced,
+													 "complained"   => :complained,
+													 "email does not exist in list" => :not_in_list }
+
+      cleaned_body = clean_body(result)
+			if result.success? && success_messages.keys.include?(cleaned_body)
+				respond_with_success(result, success_messages[cleaned_body])
+			else
+				respond_with_failure(result, underscore(cleaned_body).to_sym)
+			end
+		end
+
+		def update_subscription(email, opts = {})
+			return noop if @noop
+
+			status = subscription_status(email: email)
+
+			return false if status == :not_in_list
+
+			# Trying to change the email address?
+			# Need to unsubscribe and subscribe again.
+			if (!opts[:email].nil? && opts[:email] != email) &&
+				[:subscribed, :unconfirmed, :bounced, :soft_bounced].include?(status)
+				unsubscribe(email: email)
+			end
+
+			unless [:complained, :unsubscribed].include?(status)
+				subscribe({email: email}.merge(opts)) == true
+			else
+				false
+			end
+		end
+
+		def active_subscriber_count(opts = {})
+			return noop if @noop
+
+			opts = {api_key: @api_key, list_id: @list_id}.merge(opts)
+			raise_if_missing_arg([:list_id, :api_key], opts)
+
+			path   = '/api/subscribers/active-subscriber-count.php'
+			result = post_to(path, opts)
+
+			cleaned_body = clean_body(result)
+			if result.success? && !!(cleaned_body =~ /^[-+]?[0-9]+$/)
+				respond_with_success(result, cleaned_body.to_i)
+			else
+				respond_with_failure(result)
+			end
+		end
+
+	private
+		def raise_if_missing_arg(mandatory_fields, opts)
+			mandatory_fields.each do |key|
+				if opts[key].nil? || opts[key].to_s.strip == ''
+					raise ArgumentError.new("You must specify :#{key}.")
+				end
+			end; nil
+		end
+
+		def post_to(path, params)
+			Faraday.post(url_for(path), params)
+		end
+
+		def url_for(path)
+			return File.join(@base_uri, path)
+		end
+
+		def clean_body(result)
+			result.body.strip.chomp.downcase
+		end
+
+		def respond_with_success(result, value = nil)
+			@last_result = result
+			value.nil? ? true : value
+		end
+
+		def respond_with_failure(result, value = nil)
+			@last_result = result
+			value.nil? ? false : value
+		end
+
+    def underscore(word)
+      word.gsub(/::/, '/').
+      gsub(/\s/, '_').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+
+		def noop
+			:noop
+		end
+	end
+end

data/lib/sendyr/version.rb

@@ -0,0 +1,3 @@
+module Sendyr
+  VERSION = "0.2.1.1"
+end

data/lib/sendyr.rb

@@ -0,0 +1,21 @@
+require "faraday"
+require "require_all"
+require_all File.dirname(__FILE__) + "/sendyr"
+
+module Sendyr
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :url, :api_key, :noop
+
+    def initialize
+    end
+  end
+end

data/sendyr.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sendyr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ct_sendyr"
+  spec.version       = Sendyr::VERSION
+  spec.authors       = [" "]
+  spec.email         = [" "]
+  spec.summary       = %q{A Ruby interface for the wonderful e-mail newsletter application Sendy.}
+  spec.homepage      = "http://github.com/coupontom/sendyr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "require_all"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+end

data/spec/sendyr_client_spec.rb

@@ -0,0 +1,207 @@
+require 'spec_helper'
+
+describe Sendyr::Client do
+	before do
+		@base_url = 'http://localhost'
+		@api_key  = '1234567890'
+		@email    = 'john@example.org'
+		@list_id  = '1'
+
+		Sendyr.configure do |c|
+			c.url     = @base_url
+			c.api_key = @api_key
+		end
+	end
+
+	let(:client) { Sendyr::Client.new(@list_id) }
+
+	describe ".initialize" do
+	  it "should properly set instance variables" do
+	  	client = Sendyr::Client.new(@list_id)
+	  	client.list_id.should  == @list_id
+	  	client.base_uri.should == @base_url
+	  	client.api_key.should  == @api_key
+	  end
+	end
+
+	describe "#subscribe" do
+		it "raises exception if email is missing" do
+			expect {
+				client.subscribe(foo: @email)
+			}.to raise_error(ArgumentError, 'You must specify :email.')
+		end
+
+		it "subscribes the email and passes the other arguments" do
+			stub_request(:post, "#{@base_url}/subscribe").
+			  with(:body => {"FirstName"=>"John",
+			  							 "boolean"=>"true",
+			  							 "email"=> @email,
+			  							 "list"=>@list_id,
+			  							 "name"=>"John Smith"}).
+        to_return(:status => 200, :body => "true")
+
+			client.subscribe(email: @email, name: 'John Smith', "FirstName" => "John").should == true
+		end
+
+		it "succeeds when the response body is '1'" do
+			# The API doc says it should return 'true', but we see '1' in real life.
+			stub_request(:post, "#{@base_url}/subscribe").
+			  with(:body => {"boolean"=>"true",
+			  							 "email"=> @email,
+			  							 "list"=>@list_id}).
+        to_return(:status => 200, :body => "1")
+
+			client.subscribe(email: @email).should == true
+		end
+
+		it "fails when the response message is an error" do
+			stub_request(:post, "#{@base_url}/subscribe").
+			  with(:body => {"FirstName"=>"John",
+			  							 "boolean"=>"true",
+			  							 "email"=> @email,
+			  							 "list"=>@list_id,
+			  							 "name"=>"John Smith"}).
+        to_return(:status => 200, :body => "Already subscribed.")
+
+			client.subscribe(email: @email, name: 'John Smith', "FirstName" => "John").should == false
+		end
+	end
+
+	describe "#unsubscribe" do
+		it "raises exception if email is missing" do
+			expect {
+				client.unsubscribe(foo: @email)
+			}.to raise_error(ArgumentError, 'You must specify :email.')
+		end
+
+		it "unsubscribes the email" do
+			stub_request(:post, "#{@base_url}/unsubscribe").
+			  with(:body => {"boolean"=>"true",
+			  							 "email"=> @email,
+			  							 "list"=>@list_id}).
+        to_return(:status => 200, :body => "true")
+
+			client.unsubscribe(email: @email).should == true
+		end
+
+		it "succeeds when the response body is '1'" do
+			# The API doc says it should return 'true', but we see '1' in real life.
+			stub_request(:post, "#{@base_url}/unsubscribe").
+			  with(:body => {"boolean"=>"true",
+			  							 "email"=> @email,
+			  							 "list"=>@list_id}).
+        to_return(:status => 200, :body => "1")
+
+			client.unsubscribe(email: @email).should == true
+		end
+
+		it "fails when the response message is an error" do
+			stub_request(:post, "#{@base_url}/unsubscribe").
+				with(:body => {"boolean"=>"true",
+											 "email"=> @email,
+											 "list"=>@list_id}).
+        to_return(:status => 200, :body => "Invalid email address.")
+
+			client.unsubscribe(email: @email).should == false
+		end
+	end
+
+	describe "#subscription_status" do
+		it "raises exception if email is missing" do
+			expect {
+				client.subscription_status(foo: @email)
+			}.to raise_error(ArgumentError, 'You must specify :email.')
+		end
+
+		it "returns the correct response when email is not in list" do
+			body = "Email does not exist in list"
+
+			stub_request(:post, "#{@base_url}/api/subscribers/subscription-status.php").
+				with(:body => {"api_key"=> @api_key,
+											 "email"  => @email,
+											 "list_id"=> @list_id}).
+        to_return(:status => 200, :body => body)
+
+      client.subscription_status(email: @email).should == :not_in_list
+		end
+
+		it "returns the correct response when other messages are returned" do
+			messages = ["Subscribed","Unsubscribed","Unconfirmed","Bounced","Soft Bounced","Complained"]
+			expected_responses = [:subscribed, :unsubscribed, :unconfirmed, :bounced, :soft_bounced, :complained]
+
+			messages.each_index do |i|
+				stub_request(:post, "#{@base_url}/api/subscribers/subscription-status.php").
+					with(:body => {"api_key"=> @api_key,
+												 "email"  => @email,
+												 "list_id"=> @list_id}).
+	        to_return(:status => 200, :body => messages[i])
+
+	      client.subscription_status(email: @email).should == expected_responses[i]
+			end
+		end
+	end
+
+	describe "#active_subscriber_count" do
+		it "returns the number of subscribers when the body is an integer" do
+			stub_request(:post, "#{@base_url}/api/subscribers/active-subscriber-count.php").
+				with(:body => {"api_key"=> @api_key,
+											 "list_id"=> @list_id}).
+        to_return(:status => 200, :body => "10")
+
+      client.active_subscriber_count.should == 10
+		end
+
+		it "returns false when the body is an error message" do
+			stub_request(:post, "#{@base_url}/api/subscribers/active-subscriber-count.php").
+				with(:body => {"api_key"=> @api_key,
+											 "list_id"=> @list_id}).
+        to_return(:status => 200, :body => "List does not exist")
+
+      client.active_subscriber_count.should == false
+		end
+	end
+
+		describe "#update_subscription" do
+			it "returns false if email was never subscribed" do
+				client.should_receive(:subscription_status).with(email: @email).and_return(:not_in_list)
+				client.should_receive(:unsubscribe).never
+				client.should_receive(:subscribe).never
+
+	      client.update_subscription(@email, { name: 'John'}).should == false
+			end
+
+			it "unsubscribes then creates a new subscription if trying to change email address" do
+				new_email = 'newemail@example.org'
+				name      = 'John Smith'
+
+				client.should_receive(:subscription_status).with(email: @email).and_return(:subscribed)
+				client.should_receive(:unsubscribe).with(email: @email).and_return(true)
+				client.should_receive(:subscribe).with(email: new_email, name: name).and_return(true)
+
+				client.update_subscription(@email, { email: 'newemail@example.org', name: name}).should == true
+			end
+
+			it "doesn't change the email if the user complained" do
+				new_email = 'newemail@example.org'
+				name      = 'John Smith'
+
+				client.should_receive(:subscription_status).with(email: @email).and_return(:complained)
+				client.should_receive(:unsubscribe).never
+				client.should_receive(:subscribe).never
+
+				client.update_subscription(@email, { email: 'newemail@example.org', name: name}).should == false
+			end
+
+			it "doesn't change the email if the user unsubscribed" do
+				new_email = 'newemail@example.org'
+				name      = 'John Smith'
+
+				client.should_receive(:subscription_status).with(email: @email).and_return(:unsubscribed)
+				client.should_receive(:unsubscribe).never
+				client.should_receive(:subscribe).never
+
+				client.update_subscription(@email, { email: 'newemail@example.org', name: name}).should == false
+			end
+
+		end
+end

data/spec/sendyr_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Sendyr do
+	before do
+		@base_url = 'http://localhost'
+		Sendyr.configure do |c|
+			c.url = @base_url
+		end
+	end
+
+	describe ".configure" do
+		it "configures itself properly" do
+			url = 'http://example.org'
+			api_key = 'abcd'
+
+			Sendyr.configure do |c|
+				c.url = url
+				c.api_key = api_key
+			end
+
+			Sendyr.configuration.url.should == url
+			Sendyr.configuration.api_key.should == api_key
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+ENV['RACK_ENV'] = 'test'
+
+require File.dirname(__FILE__) + '/../lib/sendyr'
+require 'webmock/rspec'
+require 'pry'
+
+RSpec.configure do |config|
+	config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: ct_sendyr
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.1.1
   prerelease: 
 platform: ruby
 authors:
-- ''
+- ! ' '
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -125,11 +125,24 @@ dependencies:
         version: '0'
 description: 
 email:
-- ''
+- ! ' '
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sendyr.rb
+- lib/sendyr/client.rb
+- lib/sendyr/version.rb
+- sendyr.gemspec
+- spec/sendyr_client_spec.rb
+- spec/sendyr_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/coupontom/sendyr
 licenses:
 - MIT
@@ -155,4 +168,7 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A Ruby interface for the wonderful e-mail newsletter application Sendy.
-test_files: []
+test_files:
+- spec/sendyr_client_spec.rb
+- spec/sendyr_spec.rb
+- spec/spec_helper.rb