sendicate 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'httparty'
+gem 'multi_json'
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'jeweler'
+  gem 'bundler'
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.2)
+    git (1.2.5)
+    httparty (0.10.2)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    multi_json (1.7.2)
+    multi_xml (0.5.3)
+    rake (10.0.4)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  httparty
+  jeweler
+  multi_json
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Evan Whalen
+
+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,74 @@
+# Sendicate
+
+This gem is a wrapper for the [Sendicate API](https://github.com/Sendicate/sendicate-docs/tree/master/api).
+
+
+## Installation
+
+    gem install sendicate
+
+
+## Requirements
+
+You will need a Sendicate account and [API token](https://www.sendicate.net/account/edit).
+
+
+## Usage
+
+Configure your API token. You can either set the environment variable SENDICATE_API_TOKEN to your api token or hardcode it.
+
+    export SENDICATE_API_TOKEN='YOUR_API_TOKEN'
+    # or
+    Sendicate.api_token = 'YOUR_API_TOKEN'
+
+Create a new list:
+
+    list = Sendicate::List.new(title: 'Life-changing newsletter')
+    list.save
+    
+View all lists:
+    
+    lists = Sendicate::List.all
+
+Update a list:
+
+    list.title = 'not spam'
+    list.save
+
+Destroy a list:
+
+    list.destroy
+
+Add a subcriber to a list:
+
+    import = Sendicate::Import.new(
+      list_id: LIST_ID, 
+      data: {
+        email: 'user@example.com', 
+        name: 'New User'
+      }
+    )
+    
+    if import.save
+      puts 'success'
+    else
+      puts import.error_messages
+    end
+
+
+## Contributing to sendicate-ruby
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+## Copyright
+
+Copyright (c) 2013 Evan Whalen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "sendicate"
+  gem.homepage = "http://github.com/evanwhalen/sendicate-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{Sendicate API Wrapper}
+  gem.description = %Q{Use this Sendicate API wrapper to subscribe your users to your Sendicate mailing lists.}
+  gem.email = "evanwhalendev@gmail.com"
+  gem.authors = ["Evan Whalen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/sendicate.rb

@@ -0,0 +1,25 @@
+require 'httparty'
+require 'multi_json'
+
+module Sendicate
+  extend self
+  
+  autoload :Import, 'sendicate/import'
+  autoload :List, 'sendicate/list'
+  autoload :Request, 'sendicate/request'
+  
+  class << self
+    attr_accessor :api_token
+  end
+  
+  class BadRequest < StandardError
+  end
+  
+  class ResourceNotFound < StandardError
+  end
+  
+  class Unauthorized < StandardError
+  end
+end
+
+Sendicate.api_token = ENV['SENDICATE_API_TOKEN']

data/lib/sendicate/import.rb

@@ -0,0 +1,52 @@
+module Sendicate
+  
+  class Import
+    include HTTParty
+    base_uri 'https://api.sendicate.net/v1'
+    headers 'Accept' => 'application/json', 'Content-Type' => 'application/json', "Authorization" => "token #{Sendicate.api_token}"
+    
+    attr_reader :list_id, :data, :response, :errors
+    
+    def initialize(attributes)
+      @list_id = attributes[:list_id]
+      @data = attributes[:data]
+    end
+    
+    def save
+      @response = Sendicate::Request.post("/lists/#{list_id}/subscribers", body: MultiJson.dump(data))
+      success?
+    end
+    
+    def success?
+      response && response.success?
+    end
+    
+    def imported
+      parsed_response["imported"]
+    end
+    
+    def updated
+      parsed_response["updated"]
+    end
+    
+    def failed
+      parsed_response["failed"]
+    end
+    
+    def parsed_response
+      response && response.parsed_response
+    end
+    
+    def errors
+      parsed_response['errors']
+    end
+    
+    def error_messages
+      errors.map do |error|
+        error['errors'].map do |e|
+          e['message']
+        end
+      end.flatten
+    end
+  end
+end

data/lib/sendicate/list.rb

@@ -0,0 +1,87 @@
+module Sendicate
+  
+  class List
+    
+    attr_reader :attributes, :errors
+    
+    def initialize(attributes={})
+      @attributes = attributes
+      @errors = {}
+    end
+    
+    def method_missing(method, *args)
+      method_string = method.to_s
+      is_setter_method = method_string[-1, 1] == '='
+      key = method_string.gsub(/\=/, '')
+      
+      if attributes.include?(key)
+        if is_setter_method
+          attributes[key] = args.first
+        else
+          attributes[key]
+        end
+      else
+        super
+      end
+    end
+
+    class << self
+      
+      def all
+        response = Sendicate::Request.get("/lists")
+        response.parsed_response.map do |attributes|
+          new(attributes)
+        end
+      end
+      
+      def find(id)
+        if id.nil?
+          raise Sendicate::ResourceNotFound
+        else
+          response = Sendicate::Request.get("/lists/#{id}")
+          new(response.parsed_response)
+        end
+      end
+    
+      def default_response_options
+        { 
+          query: { 
+            token: Sendicate.api_token 
+          }
+        }
+      end
+    end
+    
+    def save
+      response = if persisted?
+        Sendicate::Request.post("/lists", body: to_json)
+      else
+        Sendicate::Request.post("/lists/#{id}", body: to_json)
+      end
+      
+      if response.success?
+        @attributes = response.parsed_response
+        true
+      else
+        @errors = response.parsed_response
+        false
+      end
+    end
+    
+    def destroy
+      response = Sendicate::Request.delete("/lists/#{id}")
+    end
+    
+    def persisted?
+      id
+    end
+    
+    def id
+      attributes['id'] || attributes[:id]
+    end
+    
+    def to_json
+      MultiJson.dump(attributes)
+    end
+  end
+end

data/lib/sendicate/request.rb

@@ -0,0 +1,52 @@
+module Sendicate
+  
+  class Request
+    include HTTParty
+    base_uri 'https://api.sendicate.net/v1'
+    headers 'Accept' => 'application/json', 'Content-Type' => 'application/json', "Authorization" => "token #{Sendicate.api_token}"
+    
+    attr_accessor :response
+    
+    def self.get(path, options={}, &block)
+      new(super)
+    end
+    
+    def self.post(path, options={}, &block)
+      new(super)
+    end
+    
+    def self.patch(path, options={}, &block)
+      new(super)
+    end
+    
+    def self.put(path, options={}, &block)
+      new(super)
+    end
+    
+    def self.delete(path, options={}, &block)
+      new(super)
+    end
+    
+    def initialize(response)
+      @response = response
+      unless success?
+        case response.code
+        when 400
+          raise Sendicate::BadRequest
+        when 401
+          raise Sendicate::Unauthorized
+        when 404
+          raise Sendicate::ResourceNotFound
+        end
+      end
+    end
+    
+    def parsed_response
+      response.parsed_response
+    end
+    
+    def success?
+      [200, 201].include?(response.code)
+    end
+  end
+end

data/sendicate.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "sendicate"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Evan Whalen"]
+  s.date = "2013-04-02"
+  s.description = "Use this Sendicate API wrapper to subscribe your users to your Sendicate mailing lists."
+  s.email = "evanwhalendev@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/sendicate.rb",
+    "lib/sendicate/import.rb",
+    "lib/sendicate/list.rb",
+    "lib/sendicate/request.rb",
+    "sendicate.gemspec",
+    "spec/sendicate/import_spec.rb",
+    "spec/sendicate/list_spec.rb",
+    "spec/sendicate_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/evanwhalen/sendicate-ruby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Sendicate API Wrapper"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<multi_json>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<multi_json>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<multi_json>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+  end
+end
+

data/spec/sendicate/import_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Sendicate::Import do
+
+  describe "save" do
+  
+    it "should import subscriber" do
+      list = Sendicate::List.new(title: "Test list")
+      list.save
+      import = Sendicate::Import.new(
+        list_id: list.id, 
+        data: {
+          email: 'test@mailinator.com', 
+          name: 'Test subscriber'
+        }
+      )
+      import.save.should == true
+      import.failed.should == 0
+      import.error_messages.should be_empty
+      list.destroy
+    end
+    
+    it "should not import invalid subscriber" do
+      list = Sendicate::List.new(title: "Test list")
+      list.save
+      import = Sendicate::Import.new(
+        list_id: list.id, 
+        data: {
+          email: 'test@mailinator', 
+          name: 'Test subscriber'
+        }
+      )
+      import.save.should == false
+      import.failed.should == 1
+      import.error_messages.should == ["Invalid email address"]
+      list.destroy
+    end
+  end
+end

data/spec/sendicate/list_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Sendicate::List do
+  
+  describe "new" do
+    
+    it "should create list" do
+      list = Sendicate::List.new(title: "Test list")
+      list.save.should be_true
+      list.id.should_not be_nil
+      @list_id = list.id
+    end
+    
+    it "should not create list if invalid" do
+      list = Sendicate::List.new
+      list.save.should be_false
+      list.id.should be_nil
+    end
+    
+    it "should have errors if invalid" do
+      list = Sendicate::List.new
+      list.save.should be_false
+      list.errors.should == {"title"=>["can't be blank"]}
+    end
+  end
+  
+  describe "all" do
+    
+    it "should return all lists" do
+      lists = Sendicate::List.all
+      lists.size.should_not == 0
+    end
+  end
+  
+  describe "find" do
+    let(:list_id) { Sendicate::List.all.first.id }
+    
+    it "should find list" do
+      list = Sendicate::List.find(list_id)
+      list.id.should == list_id
+    end
+    
+    it "should not find invalid list" do
+      lambda { Sendicate::List.find(@list_id) }.should raise_error(Sendicate::ResourceNotFound)
+    end
+  end
+  
+  describe "save" do
+    let(:list_id) { Sendicate::List.all.select{|l| l.title == 'Test list'}.first.id }
+  
+    it "should update list" do
+      list = Sendicate::List.find(list_id)
+      list.title = "Test list updated"
+      list.save.should be_true
+    end
+    
+    it "should not update list if invalid" do
+      list = Sendicate::List.find(list_id)
+      list.title = ""
+      list.save.should be_false
+    end
+  end
+  
+  describe "destroy" do
+      
+    it "should destroy list" do
+      list = Sendicate::List.all.each do |list|
+        if list.title == 'Test list' || list.title == 'Test list updated'
+          list.destroy.should be_true
+        end
+      end
+    end
+  end
+end

data/spec/sendicate_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Sendicate do
+
+  describe "api_token" do
+    
+    it "should set token to env var" do
+      Sendicate.api_token.should == ENV['SENDICATE_API_TOKEN']
+    end
+    
+    it "should set token" do
+      Sendicate.api_token = 'test'
+      Sendicate.api_token.should == 'test'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+ENV['RACK_ENV'] ||= 'test'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sendicate'

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: sendicate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Evan Whalen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use this Sendicate API wrapper to subscribe your users to your Sendicate
+  mailing lists.
+email: evanwhalendev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/sendicate.rb
+- lib/sendicate/import.rb
+- lib/sendicate/list.rb
+- lib/sendicate/request.rb
+- sendicate.gemspec
+- spec/sendicate/import_spec.rb
+- spec/sendicate/list_spec.rb
+- spec/sendicate_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/evanwhalen/sendicate-ruby
+licenses:
+- MIT
+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: -2513087585823548954
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Sendicate API Wrapper
+test_files: []