gibbon 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca357e9533b74ca6b5616efc8e889abecc7b8a11
-  data.tar.gz: 8967cd26e5356e76bc35524104ce85ae74ef2a90
+  metadata.gz: b9bbaffb886d48a6638dad933173180c5fa05a83
+  data.tar.gz: 3738e10aac82b774d4e835ef4d920195c08f0989
 SHA512:
-  metadata.gz: 78679e70c47bdd67ad5935462b2c5a8b13cb25724721ddfda1a5149458e63cbc77c7436d704d277d944035cce0f1f93396f737ff4ee0f6292c1d1b91d47a9728
-  data.tar.gz: cd734f687b717a69dbb338fe8120b3f107a1fd7c99a8fc9028974804fcb27077a8e6d9246f9d39a7cb602c957d85b3c91ea900490f381be922b4082d4ae824b8
+  metadata.gz: 24b23d7562c0ec6a3b0afc359c2d22e7030438030bddbbec84cc008740e438736fb95f98d419377e91e915073a296a3b82c9f488d7792856deb7dc4530952fe6
+  data.tar.gz: 03b4df6bcafa1af1a13694e7dc2a71149a4eb64bb3f43653f006dcb97e7bb0bb346933a2b9e864cc82ac35dcd12b5efa01daea136b2ac632566e04a0cf2c1de7

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 ## [Unreleased][unreleased]
 
-## [2.1.3] - 2015-11-05
+## [2.2.0] - 2015-12-01
+- Adds support for proxies
+- Adds support for faraday_adapters
+
+## [2.1.3] - 2015-11-26
 - Fixes issue #159, which prevented sending campaigns from working. Thanks to @q3-tech for the bug report.
 
-## [2.1.2] - 2015-11-05
+## [2.1.2] - 2015-11-11
 - Allow Faraday default\_connection\_options to be set
 
 ## [2.1.1] - 2015-11-05

data/README.markdown

@@ -37,23 +37,7 @@ are specified inline and a `CRUD` (`create`, `retrieve`, `update`, `upsert`, or
 
 *Please note that `upsert` requires Gibbon version 2.1.0 or newer!*
 
-```ruby
-gibbon.lists.retrieve
-```
-
-Retrieving a specific list looks like:
-
-```ruby
-gibbon.lists(list_id).retrieve
-```
-
-Retrieving a specific list's members looks like:
-
-```ruby
-gibbon.lists(list_id).members.retrieve
-```
-
-You can also specify `headers`, `params`, and `body` when calling a `CRUD` method. For example:
+You can specify `headers`, `params`, and `body` when calling a `CRUD` method. For example:
 
 ```ruby
 gibbon.lists.retrieve(headers: {"SomeHeader": "SomeHeaderValue"}, params: {"query_param": "query_param_value"})
@@ -85,23 +69,31 @@ gibbon = Gibbon::Request.new
 MailChimp's [resource documentation](http://kb.mailchimp.com/api/resources) is a list of available resources. Substitute an underscore if
 a resource name contains a hyphen.
 
-### Fetching Campaigns
+## Examples
+
+### Lists
+
+Fetch all lists:
 
 ```ruby
-campaigns = gb.campaigns.retrieve
+gibbon.lists.retrieve
 ```
 
-### Fetching Lists
+Retrieving a specific list looks like:
 
-Similarly, to fetch your lists
+```ruby
+gibbon.lists(list_id).retrieve
+```
+
+Retrieving a specific list's members looks like:
 
 ```ruby
-lists = gibbon.lists.retrieve
+gibbon.lists(list_id).members.retrieve
 ```
 
-### More Advanced Examples
+### Subscribers
 
-List subscribers for a list:
+Get all subscribers for a list:
 
 ```ruby
 gibbon.lists(list_id).members.retrieve
@@ -125,17 +117,70 @@ You can also unsubscribe a member from a list:
 gibbon.lists(list_id).members(member_id).update(body: { status: "unsubscribed" })
 ```
 
+### Campaigns
+
+Get all campaigns:
+
+```ruby
+campaigns = gibbon.campaigns.retrieve
+```
+
 Fetch the number of opens for a campaign
 
 ```ruby
 email_stats = gibbon.reports(campaign_id).retrieve["opens"]
 ```
 
-Overriding Gibbon's API endpoint (i.e. if using an access token from OAuth and have the `api_endpoint` from the [metadata](http://apidocs.mailchimp.com/oauth2/)):
+Create a new campaign:
 
 ```ruby
-Gibbon::Request.api_endpoint = "https://us1.api.mailchimp.com"
-Gibbon::Request.api_key = your_access_token_or_api_key
+recipients = {
+  list_id: list_id,
+  segment_opts: {
+    saved_segment_id: segment_id
+  }
+}
+settings = {
+  subject_line: "Subject Line",
+  title: "Name of Campaign",
+  from_name: "From Name",
+  reply_to: "my@email.com"
+}
+
+body = {
+  type: "regular",
+  recipients: recipients,
+  settings: settings
+}
+
+begin
+  gibbon.campaigns.create(body: body)
+rescue Gibbon::MailChimpError => e
+  puts "Houston, we have a problem: #{e.message} - #{e.raw_body}"
+end
+```
+
+Add content to a campaign:
+
+*(Please note that Mailchimp does not currently support dynamic replacement of mc:edit areas in their drag-and-drop templates using their API.  Custom templates [can be used](http://stackoverflow.com/questions/29366766/mailchimp-api-not-replacing-mcedit-content-sections-using-ruby-library) instead.)*
+
+```ruby
+body = {
+  template: {
+    id: template_id,
+    sections: {
+      "name-of-mc-edit-area": "Content here"
+    }
+  }
+}
+
+gibbon.campaigns(campaign_id).content.upsert(body: body)
+```
+
+Send a campaign:
+
+```ruby
+gibbon.campaigns(campaign_id).actions.send.create
 ```
 
 ### Interests
@@ -193,6 +238,27 @@ Gibbon raises an error when the API returns an error.
 Gibbon::MailChimpError has the following attributes: `title`, `detail`, `body`, `raw_body`, `status_code`. Some or all of these may not be
 available depending on the nature of the error.
 
+### Other
+
+Overriding Gibbon's API endpoint (i.e. if using an access token from OAuth and have the `api_endpoint` from the [metadata](http://apidocs.mailchimp.com/oauth2/)):
+
+```ruby
+Gibbon::Request.api_endpoint = "https://us1.api.mailchimp.com"
+Gibbon::Request.api_key = your_access_token_or_api_key
+```
+
+You can set an optional proxy url like this (or with an environment variable MAILCHIMP_PROXY):
+
+```ruby
+gibbon.proxy = 'http://your_proxy.com:80'
+```
+
+You can set a different Faraday adapter during initialization:
+
+```ruby
+gibbon = Gibbon::Request.new(api_key: "your_api_key", faraday_adapter: :net_http)
+```
+
 ### Migrating from Gibbon 1.x
 
 Gibbon 2.x has different syntax from version 1.x. This is because Gibbon maps to MailChimp's API and because version 3 of the API is quite different from version 2. First, the name of the primary class has changed from `API` to `Request`. And the way you pass an API key during initialization is different. A few examples below.
@@ -261,5 +327,5 @@ Thanks to everyone who has [contributed](https://github.com/amro/gibbon/contribu
 
 ## Copyright
 
-* Copyright (c) 2010-2015 Amro Mousa. See LICENSE.txt for details.
-* MailChimp (c) 2001-2015 The Rocket Science Group.
+* Copyright (c) 2010-2016 Amro Mousa. See LICENSE.txt for details.
+* MailChimp (c) 2001-2016 The Rocket Science Group.

data/gibbon.gemspec

@@ -13,9 +13,7 @@ Gem::Specification.new do |s|
   s.description = %q{A wrapper for MailChimp API 3.0}
   s.license     = "MIT"
 
-  s.post_install_message = "IMPORTANT: Gibbon now targets MailChimp API 3.0, which is very different from API 2.0.\n \
-                            Please install Gibbon 1.2.0 if you need to use API 2.0.\nGibbon's API has changed substantially \
-                            between versions 1.x and 2.x."
+  s.post_install_message = "IMPORTANT: Gibbon now targets MailChimp API 3.0, which is very different from API 2.0. Use Gibbon 1.x if you need to target API 2.0."
 
   s.rubyforge_project = "gibbon"
 

data/lib/gibbon.rb

@@ -8,4 +8,4 @@ require 'gibbon/request'
 require 'gibbon/api_request'
 
 module Gibbon
-end
+end

data/lib/gibbon/api_request.rb

@@ -16,7 +16,7 @@ module Gibbon
         handle_error(e)
       end
     end
-    
+
     def patch(params: nil, headers: nil, body: nil)
       validate_api_key
 
@@ -42,7 +42,7 @@ module Gibbon
         handle_error(e)
       end
     end
-    
+
     def get(params: nil, headers: nil)
       validate_api_key
 
@@ -55,7 +55,7 @@ module Gibbon
         handle_error(e)
       end
     end
-    
+
     def delete(params: nil, headers: nil)
       validate_api_key
 
@@ -70,20 +70,28 @@ module Gibbon
     end
 
     protected
-    
+
     # Convenience accessors
-  
+
     def api_key
       @request_builder.api_key
     end
-    
+
     def api_endpoint
       @request_builder.api_endpoint
     end
-    
+
     def timeout
       @request_builder.timeout
     end
+    
+    def proxy
+      @request_builder.proxy
+    end
+
+    def adapter
+      @request_builder.faraday_adapter
+    end
 
     # Helpers
 
@@ -124,9 +132,9 @@ module Gibbon
     end
 
     def rest_client
-      client = Faraday.new(self.api_url) do |faraday|
+      client = Faraday.new(self.api_url, proxy: self.proxy) do |faraday|
         faraday.response :raise_error
-        faraday.adapter Faraday.default_adapter
+        faraday.adapter adapter
       end
       client.basic_auth('apikey', self.api_key)
       client

data/lib/gibbon/request.rb

@@ -1,15 +1,17 @@
 module Gibbon
   class Request
-    attr_accessor :api_key, :api_endpoint, :timeout
+    attr_accessor :api_key, :api_endpoint, :timeout, :proxy, :faraday_adapter
 
     DEFAULT_TIMEOUT = 30
 
-    def initialize(api_key: nil, api_endpoint: nil, timeout: nil)
+    def initialize(api_key: nil, api_endpoint: nil, timeout: nil, proxy: nil, faraday_adapter: nil)
       @path_parts = []
       @api_key = api_key || self.class.api_key || ENV['MAILCHIMP_API_KEY']
       @api_key = @api_key.strip if @api_key
       @api_endpoint = api_endpoint || self.class.api_endpoint
       @timeout = timeout || self.class.timeout || DEFAULT_TIMEOUT
+      @proxy = proxy || self.class.proxy || ENV['MAILCHIMP_PROXY']
+      @faraday_adapter = faraday_adapter || Faraday.default_adapter
     end
 
     def method_missing(method, *args)
@@ -19,7 +21,7 @@ module Gibbon
       @path_parts.flatten!
       self
     end
-    
+
     def send(*args)
       if args.length == 0
         method_missing(:send, args)
@@ -27,7 +29,7 @@ module Gibbon
         __send__(*args)
       end
     end
-    
+
     def path
       @path_parts.join('/')
     end
@@ -69,10 +71,10 @@ module Gibbon
     end
 
     class << self
-      attr_accessor :api_key, :timeout, :api_endpoint
+      attr_accessor :api_key, :timeout, :api_endpoint, :proxy
 
       def method_missing(sym, *args, &block)
-        new(api_key: self.api_key, api_endpoint: self.api_endpoint, timeout: self.timeout).send(sym, *args, &block)
+        new(api_key: self.api_key, api_endpoint: self.api_endpoint, timeout: self.timeout, proxy: self.proxy).send(sym, *args, &block)
       end
     end
   end

data/lib/gibbon/version.rb

@@ -1,3 +1,3 @@
 module Gibbon
-  VERSION = "2.1.3"
+  VERSION = "2.2.0"
 end

data/spec/gibbon/gibbon_spec.rb

@@ -7,32 +7,32 @@ describe Gibbon do
       Gibbon::APIRequest.send(:public, *Gibbon::APIRequest.protected_instance_methods)
 
       @api_key = "123-us1"
+      @proxy = 'the_proxy'
     end
 
     it "have no API by default" do
       @gibbon = Gibbon::Request.new
       expect(@gibbon.api_key).to be_nil
     end
-
-    it "set an API key in constructor" do
+    it "sets an API key in the constructor" do
       @gibbon = Gibbon::Request.new(api_key: @api_key)
       expect(@gibbon.api_key).to eq(@api_key)
     end
 
-    it "set an API key from the 'MAILCHIMP_API_KEY' ENV variable" do
+    it "sets an API key from the 'MAILCHIMP_API_KEY' ENV variable" do
       ENV['MAILCHIMP_API_KEY'] = @api_key
       @gibbon = Gibbon::Request.new
       expect(@gibbon.api_key).to eq(@api_key)
       ENV.delete('MAILCHIMP_API_KEY')
     end
 
-    it "set an API key via setter" do
+    it "sets an API key via setter" do
       @gibbon = Gibbon::Request.new
       @gibbon.api_key = @api_key
       expect(@gibbon.api_key).to eq(@api_key)
     end
 
-    it "set timeout and get" do
+    it "sets timeout and get" do
       @gibbon = Gibbon::Request.new
       timeout = 30
       @gibbon.timeout = timeout
@@ -52,6 +52,30 @@ describe Gibbon do
       @gibbon = Gibbon::Request.new(api_key: @api_key, api_endpoint: api_endpoint)
       expect(api_endpoint).to eq(@gibbon.api_endpoint)
     end
+
+    it "has no Proxy url by default" do
+      @gibbon = Gibbon::Request.new
+      expect(@gibbon.proxy).to be_nil
+    end
+
+    it "sets an proxy url key from the 'MAILCHIMP_PROXY_URL' ENV variable" do
+      ENV['MAILCHIMP_PROXY'] = @proxy
+      @gibbon = Gibbon::Request.new
+      expect(@gibbon.proxy).to eq(@proxy)
+      ENV.delete('MAILCHIMP_PROXY')
+    end
+
+    it "sets an API key via setter" do
+      @gibbon = Gibbon::Request.new
+      @gibbon.proxy = @proxy
+      expect(@gibbon.proxy).to eq(@proxy)
+    end
+
+    it "sets an adapter in the constructor" do
+      adapter = :em_synchrony
+      @gibbon = Gibbon::Request.new(faraday_adapter: adapter)
+      expect(@gibbon.faraday_adapter).to eq(adapter)
+    end
   end
 
   describe "build api url" do
@@ -117,4 +141,3 @@ describe Gibbon do
     end
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -110,10 +110,8 @@ homepage: http://github.com/amro/gibbon
 licenses:
 - MIT
 metadata: {}
-post_install_message: |-
-  IMPORTANT: Gibbon now targets MailChimp API 3.0, which is very different from API 2.0.
-                               Please install Gibbon 1.2.0 if you need to use API 2.0.
-  Gibbon's API has changed substantially                             between versions 1.x and 2.x.
+post_install_message: 'IMPORTANT: Gibbon now targets MailChimp API 3.0, which is very
+  different from API 2.0. Use Gibbon 1.x if you need to target API 2.0.'
 rdoc_options: []
 require_paths:
 - lib