cindy 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a789e5f76abe87afdea1484025133acf9cb29c8b
+  data.tar.gz: 255fc1cb5d72c868518745017bfec8d15214afa3
+SHA512:
+  metadata.gz: 0f5a27dea85815171a10bbd8b304df648a173dae7cf8bd909c664ab2ac330d4aaa4848bb10925e5140d68f3d79c7375dc93c1535f7dcead38d4c7b8a63c4217a
+  data.tar.gz: 08627111d620c02c3f9714afb552a11fe0907afe6c7b327ec0e4651c2ae6250e7cba0934a85f667945adb21b1799ae69c53ca11c9e88ae1fab16e276e7651e1f

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.2.0
+
+* Add create campaigns API
+
+## 0.1.1
+
+* Fix URL path issues when Sendy installed in a folder
+
+## 0.1.0
+
+* First release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Richard Lee
+Copyright (c) 2014-2015 Polydice, Inc. http://polydice.com
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,24 +1,10 @@
 # Cindy
 
-A lightweight and flexible Ruby SDK for Sendy, a self-hosted email newsletter app.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'cindy'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install cindy
+A lightweight and flexible Ruby SDK for [Sendy](http://sendy.co), a self-hosted email newsletter app.
 
 ## Usage
 
-The API of Cindy was basically implemented after Sendy's API doc.
+The API of Cindy was basically implemented after [Sendy's API documentation](http://sendy.co/api).
 
 ### Client
 
@@ -38,44 +24,43 @@ There're two parameters for initialize method:
 Then you can subscribe or unsubscribe from a list:
 
 ```ruby
-> c.subscribe 1, "foo@bar.com", "Foo Bar"
+> c.subscribe list_id, "foo@bar.com", "My Name"
 => true
-> c.unsubscribe 1, "foo@bar.com"
+> c.unsubscribe list_id, "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"
+> c.subscription_status list_id, "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
+> c.active_subscriber_count list_id
 => 1660
 ```
 
-The only required parameter here is list ID.
+### Create Campaign
+
+To create new campaign:
+
+```ruby
+> c.create_campaign from_name: "foo", from_email: "foo@bar.com", reply_to: "foo@bar.com", subject: "Hello, world", html_text: "<h1>Hello, world</h1>"
+=> Campaign created
+```
+
+### More Reference
+
+Check [Sendy's API documentation](http://sendy.co/api) to learn more about parameters and possible responses.
 
-## Contributing
+## License
 
-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
+MIT License. Copyright 2013-2015 Polydice, Inc. http://polydice.com/

data/cindy.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency("faraday", "~> 0.8.5")
   gem.add_dependency('faraday_middleware', '~> 0.9')
-  gem.add_dependency('hashie', '~> 1.0')
+  gem.add_dependency('hashie', '~> 3.4')
 
-  gem.add_development_dependency("rake", "~> 10.0.3")
+  gem.add_development_dependency("rake", "~> 10.4.2")
   gem.add_development_dependency("rspec", "~> 2.12.0")
 end

data/lib/cindy/client.rb

@@ -10,6 +10,24 @@ module Cindy
       @key = api_key || ENV['SENDY_API_KEY']
     end
 
+    def create_campaign(opts={})
+      post_opts     = {}
+      req_opts      = %i(from_name from_email reply_to subject html_text)
+      optional_opts = %i(plain_text list_ids brand_id send_campaign)
+
+      req_opts.each do |opt|
+        post_opts[opt] = opts.delete(opt) || raise(ArgumentError, "opt :#{opt} required")
+      end
+      post_opts.merge!(Hash[optional_opts.zip(opts.values_at(*optional_opts))])
+      post_opts[:api_key] = @key
+
+      response = connection.post "api/campaigns/create.php" do |req|
+        req.body = post_opts
+      end
+
+      response.body
+    end
+
     def subscribe(list_id, email, name = nil)
       response = connection.post "subscribe" do |req|
         params = {list: list_id, email: email, boolean: true}

data/lib/cindy/version.rb

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

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: cindy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2015-03-03 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'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: 10.4.2
 - !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 and flexible Ruby SDK for Sendy, a self-hosted email newsletter
@@ -99,7 +88,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -114,33 +104,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/polydice/cindy
 licenses: []
+metadata: {}
 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: 458817470036857709
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 458817470036857709
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple Ruby wrapper for Sendy API.
 test_files:
 - spec/cindy_spec.rb