cindy 0.1.0 → 0.1.1

data/README.md

@@ -1,6 +1,6 @@
 # Cindy
 
-TODO: Write a gem description
+A lightweight and flexible Ruby SDK for Sendy, a self-hosted email newsletter app.
 
 ## Installation
 
@@ -18,7 +18,59 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The API of Cindy was basically implemented after Sendy's API doc.
+
+### Client
+
+To use Cindy, first create a client instance:
+
+```ruby
+c = Cindy.new "http://sendy.co/demo/", "QywLZqDddP2P//d6ntekf+GY82nLrHke"
+```
+
+There're two parameters for initialize method:
+
+1. API Endpoint - The URL for Sendy installation.
+2. API Key - Optional, only for subscription status methods.
+
+### Subscribe / Unsubscribe
+
+Then you can subscribe or unsubscribe from a list:
+
+```ruby
+> c.subscribe 1, "foo@bar.com", "Foo Bar"
+=> true
+> c.unsubscribe 1, "foo@bar.com"
+=> false
+```
+
+The parameters are:
+
+1. List ID - You can find them under list management page.
+2. Email - Email to subscribe or unsubscribe from the list
+3. Name - Optional, used only for subscribe
+
+### Subscription Status
+
+To check subscription status for Email address:
+
+```ruby
+> c.subscription_status 3, "foo@bar.com"
+=> "Unsubscribed"
+```
+
+The parameters are list ID and Email.
+
+### Active Subscriber Count
+
+To get active subscriber count of a list:
+
+```ruby
+> c.active_subscriber_count 5
+=> 1660
+```
+
+The only required parameter here is list ID.
 
 ## Contributing
 

data/cindy.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   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.description   = %q{A lightweight and 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"
 

data/lib/cindy/client.rb

@@ -11,7 +11,7 @@ module Cindy
     end
 
     def subscribe(list_id, email, name = nil)
-      response = connection.post "/subscribe" do |req|
+      response = connection.post "subscribe" do |req|
         params = {list: list_id, email: email, boolean: true}
         params[:name] = name if name
         req.body = params
@@ -21,13 +21,13 @@ module Cindy
     end
 
     def unsubscribe(list_id, email)
-      response = connection.post "/unsubscribe", {list: list_id, email: email, boolean: true}
+      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|
+      response = connection.post "api/subscribers/subscription-status.php" do |req|
         req.body = {list_id: list_id, email: email, api_key: @key}
       end
 
@@ -35,7 +35,7 @@ module Cindy
     end
 
     def active_subscriber_count(list_id)
-      response = connection.post "/api/subscribers/active-subscriber-count.php" do |req|
+      response = connection.post "api/subscribers/active-subscriber-count.php" do |req|
         req.body = {list_id: list_id, api_key: @key}
       end
 

data/lib/cindy/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cindy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-08 00:00:00.000000000 Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -91,7 +91,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.12.0
-description: A lightweight, flexible Ruby SDK for Sendy, a self-hosted email newsletter
+description: A lightweight and flexible Ruby SDK for Sendy, a self-hosted email newsletter
   app.
 email:
 - rl@polydice.com
@@ -126,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3277110265652980216
+      hash: 458817470036857709
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3277110265652980216
+      hash: 458817470036857709
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23