sendicate 0.1.0 → 0.2.0

data/README.md

@@ -2,6 +2,8 @@
 
 This gem is a wrapper for the [Sendicate API](https://github.com/Sendicate/sendicate-docs/tree/master/api).
 
+Find out more about Sendicate at [https://www.sendicate.net/](https://www.sendicate.net/).
+
 
 ## Installation
 
@@ -10,7 +12,7 @@ This gem is a wrapper for the [Sendicate API](https://github.com/Sendicate/sendi
 
 ## Requirements
 
-You will need a Sendicate account and [API token](https://www.sendicate.net/account/edit).
+You will need a Sendicate account and [API token](https://www.sendicate.net/account/edit).  The token can be found by logging into your Sendicate account and going to Manage, then Account, then scrolling down to API Access.
 
 
 ## Usage
@@ -21,9 +23,12 @@ Configure your API token. You can either set the environment variable SENDICATE_
     # or
     Sendicate.api_token = 'YOUR_API_TOKEN'
 
+
+### Lists
+
 Create a new list:
 
-    list = Sendicate::List.new(title: 'Life-changing newsletter')
+    list = Sendicate::List.new(title: 'Life-changing newsletter list')
     list.save
     
 View all lists:
@@ -32,7 +37,7 @@ View all lists:
 
 Update a list:
 
-    list.title = 'not spam'
+    list.title = 'new list'
     list.save
 
 Destroy a list:
@@ -56,6 +61,18 @@ Add a subcriber to a list:
     end
 
 
+### Subscribers
+
+Change a subscriber's email address:
+
+    subscriber = Subscriber.find('user@example.com')
+    subscriber.email = 'differentuser@example.com'
+    subscriber.save
+
+Unsubscribe a subscriber:
+
+    Subscriber.unsubscribe('user@example.com')
+
 ## 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.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/sendicate.rb

@@ -7,6 +7,8 @@ module Sendicate
   autoload :Import, 'sendicate/import'
   autoload :List, 'sendicate/list'
   autoload :Request, 'sendicate/request'
+  autoload :Resource, 'sendicate/resource'
+  autoload :Subscriber, 'sendicate/subscriber'
   
   class << self
     attr_accessor :api_token

data/lib/sendicate/import.rb

@@ -1,9 +1,6 @@
 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
     
@@ -13,7 +10,7 @@ module Sendicate
     end
     
     def save
-      @response = Sendicate::Request.post("/lists/#{list_id}/subscribers", body: MultiJson.dump(data))
+      @response = Request.post("/lists/#{list_id}/subscribers", body: MultiJson.dump(data))
       success?
     end
     

data/lib/sendicate/list.rb

@@ -1,87 +1,6 @@
 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
+  class List < Resource
+    base_path '/lists'
   end
 end

data/lib/sendicate/request.rb

@@ -32,11 +32,11 @@ module Sendicate
       unless success?
         case response.code
         when 400
-          raise Sendicate::BadRequest
+          raise BadRequest
         when 401
-          raise Sendicate::Unauthorized
+          raise Unauthorized
         when 404
-          raise Sendicate::ResourceNotFound
+          raise ResourceNotFound
         end
       end
     end

data/lib/sendicate/resource.rb

@@ -0,0 +1,120 @@
+module Sendicate
+  
+  class Resource
+    include HTTParty
+    base_uri 'https://api.sendicate.net/v1'
+    headers 'Accept' => 'application/json', 'Content-Type' => 'application/json', "Authorization" => "token #{Sendicate.api_token}"
+    
+    attr_reader :attributes, :errors, :response
+    
+    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 is_setter_method
+        attributes[key] = args.first
+      elsif attributes.include?(key)
+        attributes[key]
+      else
+        super
+      end
+    end
+    
+    class << self
+      
+      def base_path(path)
+        @base_path = path
+      end
+      
+      def all
+        response = get(collection_path)
+        response.parsed_response.map do |attributes|
+          new(attributes)
+        end
+      end
+      
+      def find(param)
+        if param.nil?
+          raise ResourceNotFound
+        else
+          response = get(member_path(param))
+          new(response.parsed_response)
+        end
+      end
+      
+      def collection_path
+        @base_path
+      end
+      
+      def member_path(param)
+        [@base_path, param].join("/")
+      end
+      
+      def get(*args)
+        Request.get(*args)
+      end
+
+      def post(*args)
+        Request.post(*args)
+      end
+
+      def patch(*args)
+        Request.patch(*args)
+      end
+
+      def put(*args)
+        Request.put(*args)
+      end
+
+      def delete(*args)
+        Request.delete(*args)
+      end
+    end
+    
+    def save
+      response = if persisted?
+        self.class.put(member_path, body: to_json)
+      else
+        self.class.post(member_path, body: to_json)
+      end
+      
+      if response.success?
+        @attributes = response.parsed_response
+        true
+      else
+        @errors = response.parsed_response
+        false
+      end
+    end
+    
+    def destroy
+      response = self.class.delete(member_path)
+    end
+    
+    def persisted?
+      !to_param.nil?
+    end
+    
+    def id
+      attributes['id'] || attributes[:id]
+    end
+    
+    def to_param
+      id
+    end
+    
+    def to_json
+      MultiJson.dump(attributes)
+    end
+    
+    def member_path
+      self.class.member_path(to_param)
+    end
+  end
+end

data/lib/sendicate/subscriber.rb

@@ -0,0 +1,24 @@
+module Sendicate
+  
+  class Subscriber < Resource
+    base_path '/subscribers'
+    
+    def email
+      attributes['email'] || attributes[:email]
+    end
+    
+    def to_param
+      id || email
+    end
+    
+    def self.unsubscribe(email)
+      subscriber = find(email)
+      subscriber.unsubscribe
+    end
+    
+    def unsubscribe
+      self.subscribed = false
+      save
+    end
+  end
+end

data/sendicate.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "sendicate"
-  s.version = "0.1.0"
+  s.version = "0.2.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.date = "2013-04-03"
   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 = [
@@ -28,9 +28,12 @@ Gem::Specification.new do |s|
     "lib/sendicate/import.rb",
     "lib/sendicate/list.rb",
     "lib/sendicate/request.rb",
+    "lib/sendicate/resource.rb",
+    "lib/sendicate/subscriber.rb",
     "sendicate.gemspec",
     "spec/sendicate/import_spec.rb",
     "spec/sendicate/list_spec.rb",
+    "spec/sendicate/subscriber_spec.rb",
     "spec/sendicate_spec.rb",
     "spec/spec_helper.rb"
   ]

data/spec/sendicate/list_spec.rb

@@ -8,7 +8,6 @@ describe Sendicate::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
@@ -41,21 +40,22 @@ describe Sendicate::List do
     end
     
     it "should not find invalid list" do
-      lambda { Sendicate::List.find(@list_id) }.should raise_error(Sendicate::ResourceNotFound)
+      lambda { Sendicate::List.find('bogus') }.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 = Sendicate::List.new(title: "Test list")
+      list.save
       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 = Sendicate::List.new(title: "Test list")
+      list.save
       list.title = ""
       list.save.should be_false
     end

data/spec/sendicate/subscriber_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Sendicate::Subscriber do
+  let(:email) { 'user@example.com' }
+  
+  before(:all) do
+    list = Sendicate::List.new(title: 'Test')
+    list.save
+    import = Sendicate::Import.new(
+      list_id: list.id,
+      data: {
+        email: 'user@example.com'
+      }
+    )
+    import.save
+  end
+  
+  after(:all) do
+    Sendicate::List.all.each do |list|
+      if list.title == 'Test'
+        list.destroy
+      end
+    end
+  end
+  
+  describe "find" do
+    
+    it "should find subscriber" do
+      subscriber = Sendicate::Subscriber.find(email)
+      subscriber.email.should == email
+    end
+    
+    it "should not find invalid list" do
+      lambda { Sendicate::Subscriber.find('bogus@example.com') }.should raise_error(Sendicate::ResourceNotFound)
+    end
+  end
+  
+  describe "save" do
+  
+    it "should update subscriber" do
+      subscriber = Sendicate::Subscriber.find(email)
+      subscriber.email = 'anotheruser@example.com'
+      subscriber.save.should be_true
+      subscriber.email = email
+      subscriber.save
+    end
+    
+    it "should not update subscriber if invalid" do
+      subscriber = Sendicate::Subscriber.find(email)
+      subscriber.email = ""
+      subscriber.save.should be_false
+    end
+  end
+  
+  describe 'unsubscribe' do
+    
+    it "should unsubscribe subscriber" do
+      Sendicate::Subscriber.unsubscribe(email).should be_true
+      subscriber = Sendicate::Subscriber.find(email)
+      subscriber.subscribed.should == false
+      subscriber.unsubscribed_at.should_not be_nil
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendicate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -127,9 +127,12 @@ files:
 - lib/sendicate/import.rb
 - lib/sendicate/list.rb
 - lib/sendicate/request.rb
+- lib/sendicate/resource.rb
+- lib/sendicate/subscriber.rb
 - sendicate.gemspec
 - spec/sendicate/import_spec.rb
 - spec/sendicate/list_spec.rb
+- spec/sendicate/subscriber_spec.rb
 - spec/sendicate_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/evanwhalen/sendicate-ruby
@@ -147,7 +150,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2513087585823548954
+      hash: -702026301068380783
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: