cindy 0.1.0

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Richard Lee
+
+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,29 @@
+# Cindy
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cindy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cindy
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/cindy.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cindy/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cindy"
+  gem.version       = Cindy::VERSION
+  gem.authors       = ["Richard Lee"]
+  gem.email         = ["rl@polydice.com"]
+  gem.description   = %q{A lightweight, flexible Ruby SDK for Sendy, a self-hosted email newsletter app.}
+  gem.summary       = %q{Simple Ruby wrapper for Sendy API.}
+  gem.homepage      = "https://github.com/polydice/cindy"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("faraday", "~> 0.8.5")
+  gem.add_dependency('faraday_middleware', '~> 0.9')
+  gem.add_dependency('hashie', '~> 1.0')
+
+  gem.add_development_dependency("rake", "~> 10.0.3")
+  gem.add_development_dependency("rspec", "~> 2.12.0")
+end

data/lib/cindy.rb

@@ -0,0 +1,16 @@
+require "cindy/version"
+require "cindy/client"
+require "cindy/error"
+
+module Cindy
+
+  class << self
+
+    def new(sendy_url, api_key = nil)
+      # Alias method for Cindy::Client
+      Cindy::Client.new(sendy_url, api_key)
+    end
+
+  end
+
+end

data/lib/cindy/client.rb

@@ -0,0 +1,59 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/response/raise_cindy_error'
+
+module Cindy
+  class Client
+
+    def initialize(sendy_url, api_key = nil)
+      @url = sendy_url
+      @key = api_key || ENV['SENDY_API_KEY']
+    end
+
+    def subscribe(list_id, email, name = nil)
+      response = connection.post "/subscribe" do |req|
+        params = {list: list_id, email: email, boolean: true}
+        params[:name] = name if name
+        req.body = params
+      end
+
+      !!(response.body =~ /^1$/)
+    end
+
+    def unsubscribe(list_id, email)
+      response = connection.post "/unsubscribe", {list: list_id, email: email, boolean: true}
+
+      !!(response.body =~ /^1$/)
+    end
+
+    def subscription_status(list_id, email)
+      response = connection.post "/api/subscribers/subscription-status.php" do |req|
+        req.body = {list_id: list_id, email: email, api_key: @key}
+      end
+
+      response.body
+    end
+
+    def active_subscriber_count(list_id)
+      response = connection.post "/api/subscribers/active-subscriber-count.php" do |req|
+        req.body = {list_id: list_id, api_key: @key}
+      end
+
+      response.body.to_i
+    end
+
+    protected
+
+    def connection
+      @connection ||= Faraday.new(:url => @url) do |faraday|
+        faraday.request  :url_encoded
+        faraday.adapter  Faraday.default_adapter
+
+        faraday.use ::Faraday::Response::RaiseCindyError
+        faraday.use ::FaradayMiddleware::FollowRedirects
+        faraday.use ::FaradayMiddleware::Mashify
+      end
+    end
+
+  end
+end

data/lib/cindy/error.rb

@@ -0,0 +1,54 @@
+module Cindy
+  # Generic error
+  class Error < StandardError; end
+
+  class NoDataPasssed < Error; end
+
+  class APIKeyNotPassed < Error; end
+
+  class InvalidAPIKey < Error; end
+
+  class EmailNotPassed < Error; end
+
+  class ListIDNotPassed < Error; end
+
+  class ListDoesNotExist < Error; end
+
+  class EmailDoesNotExistInList < Error; end
+
+  class SomeFieldsAreMissing < Error; end
+
+  class InvalidEmailAddress < Error; end
+
+  class AlreadySubscribed < Error; end
+
+  # Raised when Sendy returns a 400 HTTP status code
+  class BadRequest < Error; end
+
+  # Raised when Sendy returns a 401 HTTP status code
+  class Unauthorized < Error; end
+
+  # Raised when Sendy returns a 403 HTTP status code
+  class Forbidden < Error; end
+
+  # Raised when Sendy returns a 404 HTTP status code
+  class NotFound < Error; end
+
+  # Raised when Sendy returns a 406 HTTP status code
+  class NotAcceptable < Error; end
+
+  # Raised when Sendy returns a 422 HTTP status code
+  class UnprocessableEntity < Error; end
+
+  # Raised when Sendy returns a 500 HTTP status code
+  class InternalServerError < Error; end
+
+  # Raised when Sendy returns a 501 HTTP status code
+  class NotImplemented < Error; end
+
+  # Raised when Sendy returns a 502 HTTP status code
+  class BadGateway < Error; end
+
+  # Raised when Sendy returns a 503 HTTP status code
+  class ServiceUnavailable < Error; end
+end

data/lib/cindy/version.rb

@@ -0,0 +1,3 @@
+module Cindy
+  VERSION = "0.1.0"
+end

data/lib/faraday/response/raise_cindy_error.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+require 'cindy/error'
+
+module Faraday
+  class Response::RaiseCindyError < Response::Middleware
+
+    def on_complete(response)
+      case response[:body]
+      when /No data passed/i
+      when /Already subscribed./i
+        raise ::Cindy::AlreadySubscribed
+      when /Invalid email address./i
+        raise ::Cindy::InvalidEmailAddress
+      end
+
+      # key = response[:status].to_i
+      # raise ERROR_MAP[key].new(response) if ERROR_MAP.has_key? key
+    end
+
+  end
+end

data/spec/cindy_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Cindy do
+
+  describe ".new" do
+
+    it "is a Cindy::Client" do
+      expect(Cindy.new("http://foo.com/")).to be_a Cindy::Client
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'cindy'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: cindy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Richard Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: A lightweight, flexible Ruby SDK for Sendy, a self-hosted email newsletter
+  app.
+email:
+- rl@polydice.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cindy.gemspec
+- lib/cindy.rb
+- lib/cindy/client.rb
+- lib/cindy/error.rb
+- lib/cindy/version.rb
+- lib/faraday/response/raise_cindy_error.rb
+- spec/cindy_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/polydice/cindy
+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'
+      segments:
+      - 0
+      hash: -3277110265652980216
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3277110265652980216
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple Ruby wrapper for Sendy API.
+test_files:
+- spec/cindy_spec.rb
+- spec/spec_helper.rb