active_campaign 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb45bc281708e6be460d3e33379cd2c74c26d737
-  data.tar.gz: 12b0835d724fd3e093e1ffd0cf78db46cbc03a8f
+  metadata.gz: 8374196fd92155a286e77b4fe506b6501d9139c9
+  data.tar.gz: ec32eb1ed1f4a16715aeab31a79f9185eda64820
 SHA512:
-  metadata.gz: e5f30055cd574ede7437056b3dde2cca94043a45a06033e13af3f478e91bd42e47629be65bc62d298c4ceb42eaec1837f985e423e9a1f095bf2e4edc0f018517
-  data.tar.gz: 77b9c9106c0fd0bba33cb1eb626a293cf131d5d54d82be44d42a2ad7bcde54316222cc6aa48bb29c8cae4899852ed342a0960bd8bf504889f09eab4ac7e470e6
+  metadata.gz: 08fcb77345cb64d5de8b86387e29f592c6135d41cc0b4ab47528ec3811a5a8ba88685005f0b856766275c850c45d0ea3ee2abbe9a0ea5be4f95bc809179fcc9a
+  data.tar.gz: 48be9985590a1604bc00ef3817153bb5a8b98131e6851b5d4e665bc67811c8184cd1482045b5550ad3b4f1cc22b8fd6f36d8dfbeedd73f2e179e6068ef9cfa9b

data/README.md

@@ -1,12 +1,15 @@
 # Active::Campaign::Ruby
 
-TODO: Write a gem description
+A simple wrapper for the ActiveCampaign API. Since their API seems to be
+basically just form posts to their server don't complain here about the way it
+works. The only thing we really changed was how results are wrapped and
+returned and you can read more about that here.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'active-campaign'
+    gem 'active_campaign'
 
 And then execute:
 
@@ -14,16 +17,89 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install active-campaign
+    $ gem install active_campaign
 
 ## Usage
 
-TODO: Write usage instructions here
+Read their [API documentation](http://www.activecampaign.com/api/overview.php)for how to use this gem.
+
+```ruby
+# To fetch all lists
+ActiveCampaign.list_list ids: 'all'
+```
+
+```ruby
+# To sync a contact (create if doesn't exist or update if matching email)
+# you have to resort to some really ugly hacks. Due to the form serialization # type of API (read not a object oriented REST API) you need to translate
+# something pretty into something horrific when it comes to the parameters.
+ActiveCampaign.contact_sync({
+                                    "id" => user.active_campaign_contact_id,
+                                 "email" => user.email,
+                            "first_name" => user.first,
+                             "last_name" => user.last,
+    "p[#{user.active_campaign_list_id}]" => user.active_campaign_list_id,
+"status[#{user.active_campaign_list_id}" => user.receive_emails ? 1 : 2
+})
+
+# Another example of syncing a contact:
+
+list_params = {
+  "#{user.active_campaign_list_id}" => user.active_campaign_list_id,
+             "#{user.other_list_id}" => user.other_list_id,
+}
+
+status_params = {
+  "#{user.active_campaign_list_id}" => user.receive_emails ? 1 : 2,
+             "#{user.other_list_id}" => true ? 1 : 2,
+}
+
+ActiveCampaign.contact_sync({
+        "id" => user.active_campaign_contact_id,
+     "email" => user.email,
+"first_name" => user.first,
+ "last_name" => user.last,
+         "p" => list_params
+    "status" => status_params
+})
+```
+
+## Response
+
+All responses are wrapped under `results` so
+`ActiveCampaign.list_list ids: 'all'` returns
+
+```ruby
+{
+     "result_code" => 1,
+  "result_message" => "Success: Something is returned",
+   "result_output" => "json",
+         "results" => [
+    {
+                    "id" => "1",
+                  "name" => "One list",
+                 "cdate" => "2013-05-22 10:07:36",
+               "private" => "0",
+                "userid" => "1",
+      "subscriber_count" => 2
+    },
+    {
+                    "id" => "2",
+                  "name" => "Another List",
+                 "cdate" => "2013-05-22 10:09:15",
+               "private" => "0",
+                "userid" => "1",
+      "subscriber_count" => 0
+    }
+  ]
+}
+```
+
 
 ## 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
+4. Rebase against master we want 1 commit per feature please
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/lib/active_campaign/request.rb

@@ -19,7 +19,6 @@ module ActiveCampaign
       request(:post, api_method, options).body
     rescue => e
       puts e, e.backtrace
-      binding.pry
     end
 
     def put(api_method, options={})

data/lib/active_campaign/version.rb

@@ -1,3 +1,3 @@
 module ActiveCampaign
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/active_campaign.rb

@@ -6,7 +6,7 @@ require 'active_campaign/error'
 require 'active_campaign/client'
 
 
-require "pry"
+require "pry" rescue nil
 
 module ActiveCampaign
 

data/spec/client/lists_spec.rb

@@ -41,7 +41,6 @@ describe ActiveCampaign::Client::Lists do
       #   to_return json_response("list_view.json")
 
       lists = @client.list_list "ids" => 'all'
-      binding.pry
       expect(lists.results[0].name).to eq "Swedish Players"
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_campaign
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient