gibbon 1.2.1 → 2.0.0

data/lib/gibbon/mailchimp_error.rb

@@ -1,5 +1,5 @@
 module Gibbon
   class MailChimpError < StandardError
-    attr_accessor :code, :name
+    attr_accessor :title, :detail, :body, :raw_body, :status_code
   end
 end

data/lib/gibbon/request.rb

@@ -0,0 +1,65 @@
+module Gibbon
+  class Request
+    attr_accessor :api_key, :api_endpoint, :timeout
+
+    DEFAULT_TIMEOUT = 30
+
+    def initialize(api_key: nil, api_endpoint: nil, timeout: 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
+    end
+
+    def method_missing(method, *args)
+      # To support underscores, we replace them with hyphens when calling the API
+      @path_parts << method.to_s.gsub("_", "-").downcase
+      @path_parts << args if args.length > 0
+      @path_parts.flatten!
+      self
+    end
+    
+    def path
+      @path_parts.join('/')
+    end
+
+    def create(params: nil, headers: nil, body: nil)
+      APIRequest.new(builder: self).post(params: params, headers: headers, body: body)
+    ensure
+      reset
+    end
+
+    def update(params: nil, headers: nil, body: nil)
+      APIRequest.new(builder: self).patch(params: params, headers: headers, body: body)
+    ensure
+      reset
+    end
+
+    def retrieve(params: nil, headers: nil)
+      APIRequest.new(builder: self).get(params: params, headers: headers)
+    ensure
+      reset
+    end
+
+    def delete(params: nil, headers: nil)
+      APIRequest.new(builder: self).delete(params: params, headers: headers)
+    ensure
+      reset
+    end
+
+    protected
+
+    def reset
+      @path_parts = []
+    end
+
+    class << self
+      attr_accessor :api_key, :timeout, :api_endpoint
+
+      def method_missing(sym, *args, &block)
+        new(api_key: self.api_key, api_endpoint: self.api_endpoint, timeout: self.timeout).send(sym, *args, &block)
+      end
+    end
+  end
+end

data/lib/gibbon/version.rb

@@ -1,3 +1,3 @@
 module Gibbon
-  VERSION = "1.2.1"
-end
+  VERSION = "2.0.0"
+end

data/spec/gibbon/gibbon_spec.rb

@@ -1,87 +1,83 @@
 require 'spec_helper'
 require 'cgi'
-require 'webmock'
-require 'webmock/rspec'
 
 describe Gibbon do
-
   describe "attributes" do
-
     before do
+      Gibbon::APIRequest.send(:public, *Gibbon::APIRequest.protected_instance_methods)
+
       @api_key = "123-us1"
     end
 
     it "have no API by default" do
-      @gibbon = Gibbon::API.new
+      @gibbon = Gibbon::Request.new
       expect(@gibbon.api_key).to be_nil
     end
 
     it "set an API key in constructor" do
-      @gibbon = Gibbon::API.new(@api_key)
+      @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
       ENV['MAILCHIMP_API_KEY'] = @api_key
-      @gibbon = Gibbon::API.new
+      @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
-      @gibbon = Gibbon::API.new
+      @gibbon = Gibbon::Request.new
       @gibbon.api_key = @api_key
       expect(@gibbon.api_key).to eq(@api_key)
     end
 
     it "set timeout and get" do
-      @gibbon = Gibbon::API.new
+      @gibbon = Gibbon::Request.new
       timeout = 30
       @gibbon.timeout = timeout
       expect(timeout).to eq(@gibbon.timeout)
     end
 
+    it "timeout properly passed to APIRequest" do
+      @gibbon = Gibbon::Request.new
+      timeout = 30
+      @gibbon.timeout = timeout
+      @request = Gibbon::APIRequest.new(builder: @gibbon)
+      expect(timeout).to eq(@request.timeout)
+    end
+
     it "detect api endpoint from initializer parameters" do
       api_endpoint = 'https://us6.api.mailchimp.com'
-      @gibbon = Gibbon::API.new(@api_key, :api_endpoint => api_endpoint)
+      @gibbon = Gibbon::Request.new(api_key: @api_key, api_endpoint: api_endpoint)
       expect(api_endpoint).to eq(@gibbon.api_endpoint)
     end
-
-    it "sets the 'throws_exceptions' option from initializer parameters" do
-      @gibbon = Gibbon::API.new(@api_key, :throws_exceptions => false)
-      expect(false).to eq(@gibbon.throws_exceptions)
-    end
   end
 
   describe "build api url" do
     before do
-      @gibbon = Gibbon::API.new
-      @url = "https://api.mailchimp.com/2.0/say/hello"
+      Gibbon::APIRequest.send(:public, *Gibbon::APIRequest.protected_instance_methods)
+
+      @gibbon = Gibbon::Request.new
+      @url = "https://api.mailchimp.com/3.0/lists/"
     end
 
     it "doesn't allow empty api key" do
-      expect {@gibbon.say.hello}.to raise_error(Gibbon::GibbonError)
+      expect {@gibbon.try.retrieve}.to raise_error(Gibbon::GibbonError)
     end
 
-    it "handle malformed api key" do
+    it "doesn't allow api key without data center" do
       @api_key = "123"
       @gibbon.api_key = @api_key
-      expect_post(@url, {"apikey" => @api_key})
-      @gibbon.say.hello
+      expect {@gibbon.try.retrieve}.to raise_error(Gibbon::GibbonError)
     end
 
-    it "handle timeout" do
-      expect_post(@url, {"apikey" => 'test'}, 120)
-      @gibbon.api_key = 'test'
-      @gibbon.timeout=120
-      @gibbon.say.hello
-    end
-
-    it "handle api key with dc" do
+    it "sets correct endpoint from api key" do
       @api_key = "TESTKEY-us1"
       @gibbon.api_key = @api_key
-      expect_post("https://us1.api.mailchimp.com/2.0/say/hello", {"apikey" => @api_key})
-      @gibbon.say.hello
+      @gibbon.try
+      @request = Gibbon::APIRequest.new(builder: @gibbon)
+      expect(@request.api_url).to eq("https://us1.api.mailchimp.com/3.0/try")
     end
 
     # when the end user has signed in via oauth, api_key and endpoint it be supplied separately
@@ -89,232 +85,36 @@ describe Gibbon do
       @api_key = "TESTKEY"
       @gibbon.api_key = @api_key
       @gibbon.api_endpoint = "https://us6.api.mailchimp.com"
-      expect_post("https://us6.api.mailchimp.com/2.0/say/hello", {"apikey" => @api_key})
-      @gibbon.say.hello
+      @request = Gibbon::APIRequest.new(builder: @gibbon)
+      expect {@request.validate_api_key}.not_to raise_error
     end
   end
 
-  describe "Gibbon class variables" do
+  describe "class variables" do
     before do
-      Gibbon::API.api_key = "123-us1"
-      Gibbon::API.timeout = 15
-      Gibbon::API.throws_exceptions = false
-      Gibbon::API.api_endpoint = 'https://us6.api.mailchimp.com'
+      Gibbon::Request.api_key = "123-us1"
+      Gibbon::Request.timeout = 15
+      Gibbon::Request.api_endpoint = 'https://us6.api.mailchimp.com'
     end
 
     after do
-      Gibbon::API.api_key = nil
-      Gibbon::API.timeout = nil
-      Gibbon::API.throws_exceptions = nil
-      Gibbon::API.api_endpoint = nil
+      Gibbon::Request.api_key = nil
+      Gibbon::Request.timeout = nil
+      Gibbon::Request.api_endpoint = nil
     end
 
     it "set api key on new instances" do
-      expect(Gibbon::API.new.api_key).to eq(Gibbon::API.api_key)
+      expect(Gibbon::Request.new.api_key).to eq(Gibbon::Request.api_key)
     end
 
     it "set timeout on new instances" do
-      expect(Gibbon::API.new.timeout).to eq(Gibbon::API.timeout)
-    end
-
-    it "set throws_exceptions on new instances" do
-      expect(Gibbon::API.new.throws_exceptions).to eq(Gibbon::API.throws_exceptions)
+      expect(Gibbon::Request.new.timeout).to eq(Gibbon::Request.timeout)
     end
 
     it "set api_endpoint on new instances" do
-      expect(Gibbon::API.api_endpoint).not_to be_nil
-      expect(Gibbon::API.new.api_endpoint).to eq(Gibbon::API.api_endpoint)
-    end
-  end
-
-  describe "build api body" do
-    before do
-      @key = "TESTKEY-us1"
-      @gibbon = Gibbon::API.new(@key)
-      @url = "https://us1.api.mailchimp.com/2.0/say/hello"
-      @body = {"apikey" => @key}
-    end
-
-    it "works for string parameters" do
-      @message = "simon says"
-      expect_post(@url, @body.merge("message" => @message))
-      @gibbon.say.hello(:message => @message)
-    end
-
-    it "works for string parameters in an array" do
-      expect_post(@url, @body.merge("messages" => ["simon says", "do this"]))
-      @gibbon.say.hello(:messages => ["simon says", "do this"])
-    end
-
-    it "works for string parameters in a hash" do
-      expect_post(@url, @body.merge("messages" => {"simon says" => "do this"}))
-      @gibbon.say.hello(:messages => {"simon says" => "do this"})
-    end
-
-    it "works for nested string parameters" do
-      expect_post(@url, @body.merge("messages" => {"simon says" => ["do this", "and this"]}))
-      @gibbon.say.hello(:messages => {"simon says" => ["do this", "and this"]})
-    end
-
-    it "pass through non string parameters" do
-      expect_post(@url, @body.merge("fee" => 99))
-      @gibbon.say.hello(:fee => 99)
-    end
-
-    it "pass through http header settings" do
-      @gibbon.timeout=30
-      expect_post(@url, @body.merge("messages" => 'Simon says'), @gibbon.timeout, {'Accept-Language' => 'en'})
-      @gibbon.say.hello(:messages => 'Simon says', :headers => {'Accept-Language' => 'en'} )
-    end
-
-    it "with http headers not set" do
-      @gibbon.timeout=30
-      expect_post(@url, @body.merge("messages" => 'Simon says'), @gibbon.timeout, {})
-      @gibbon.say.hello(:messages => 'Simon says' )
-    end
-
-  end
-
-  describe "Gibbon instances" do
-    before do
-      @key = "TESTKEY-us1"
-      @gibbon = Gibbon::API.new(@key)
-      @url = "https://us1.api.mailchimp.com/2.0/say/hello"
-      @body = {"apikey" => @key}
-      @returns = Struct.new(:body).new(MultiJson.dump(["array", "entries"]))
-    end
-
-    it "produce a good exporter" do
-      @exporter = @gibbon.get_exporter
-      expect(@exporter.api_key).to eq(@gibbon.api_key)
-    end
-
-    it "not throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
-      @gibbon.throws_exceptions = false
-      allow(Gibbon::APICategory).to receive(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
-
-      @gibbon.say.hello
+      expect(Gibbon::Request.api_endpoint).not_to be_nil
+      expect(Gibbon::Request.new.api_endpoint).to eq(Gibbon::Request.api_endpoint)
     end
-
-    it "throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
-      @gibbon.throws_exceptions = true
-      allow(Gibbon::APICategory).to receive(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
-      expect {@gibbon.say.hello}.to raise_error(Gibbon::MailChimpError)
-    end
-
-    it "not raise exception if the api returns no response body" do
-      allow(Gibbon::APICategory).to receive(:post).and_return(Struct.new(:body).new(nil))
-      expect(@gibbon.say.hello).to be_nil
-    end
-
-    it "can send a campaign" do
-      allow(Gibbon::APICategory).to receive(:post).and_return(Struct.new(:body).new(MultiJson.dump({"cid" => "1234567"})))
-      expect(@gibbon.campaigns.send({"cid" => "1234567"})).to eq({"cid" => "1234567"})
-    end
-
-    it "not throw exception if configured to and the API returns an unparsable response" do
-      @gibbon.throws_exceptions = false
-      allow(Gibbon::APICategory).to receive(:post).and_return(Struct.new(:body).new("<HTML>Invalid response</HTML>"))
-      expect(@gibbon.say.hello).to eq({"name" => "UNPARSEABLE_RESPONSE", "error" => "Unparseable response: <HTML>Invalid response</HTML>", "code" => 500})
-    end
-
-    it "throw exception if configured to and the API returns an unparsable response" do
-      @gibbon.throws_exceptions = true
-      allow(Gibbon::APICategory).to receive(:post).and_return(Struct.new(:body).new("<HTML>Invalid response</HTML>"))
-      expect{@gibbon.say.hello}.to raise_error(Gibbon::MailChimpError)
-    end
-  end
-
-  describe "export API" do
-    before do
-      @key = "TESTKEY-us1"
-      @gibbon = Gibbon::Export.new(@key)
-      @url = "http://us1.api.mailchimp.com/export/1.0/"
-      @body = {:apikey => @key, :id => "listid"}
-      @return_items = ["array", "entries"]
-      @returns = MultiJson.dump(@return_items)
-    end
-
-    it "handle api key with dc" do
-      @api_key = "TESTKEY-us2"
-      @gibbon = Gibbon::Export.new(@api_key)
-
-      @body[:apikey] = @api_key
-      url = @url.gsub('us1', 'us2') + "sayHello/"
-
-      # Fake request
-      stub_request(:post, url).
-        to_return(:body => @returns, :status => 200)
-
-      # Check request url
-      @gibbon.say_hello(@body)
-      expect(WebMock).to have_requested(:post, url).with(:body => @body)
-    end
-
-    it "uses timeout if set" do
-      Gibbon::Export.timeout = 45
-      expect(Gibbon::Export.new.timeout).to eql 45
-    end
-
-    it "not throw exception if the Export API replies with a JSON hash containing a key called 'error'" do
-      @gibbon.throws_exceptions = false
-      reply = MultiJson.dump({:error => 'bad things'})
-      stub_request(:post, @url + 'sayHello/').
-        to_return(:body => reply, :status => 200)
-
-      @gibbon.say_hello(@body)
-    end
-
-    it "throw exception if configured to and the Export API replies with a JSON hash containing a key called 'error'" do
-      @gibbon.throws_exceptions = true
-      reply = MultiJson.dump({:error => 'bad things', :code => '123'})
-      stub_request(:post, @url + 'sayHello/').
-        to_return(:body => reply, :status => 200)
-
-      expect {@gibbon.say_hello(@body)}.to raise_error(Gibbon::MailChimpError)
-    end
-
-    it "should handle a single empty space response without throwing an exception" do
-      @gibbon.throws_exceptions = true
-      stub_request(:post, @url + 'sayHello/').
-        to_return(:body => " ", :status => 200)
-      #allow(Gibbon::Export).to receive(:post).and_return(Struct.new(:body).new(" "))
-
-      expect(@gibbon.say_hello(@body)).to eq([])
-    end
-
-    it "should handle an empty response without throwing an exception" do
-      @gibbon.throws_exceptions = true
-      stub_request(:post, @url + 'sayHello/').
-        to_return(:body => "", :status => 200)
-      #allow(Gibbon::Export).to receive(:post).and_return(Struct.new(:body).new(""))
-
-      expect(@gibbon.say_hello(@body)).to eq([])
-    end
-
-    it "should feed API results per row to a given block" do
-      # Fake request
-      stub_request(:post, @url + 'sayHello/').
-        to_return(:body => @returns, :status => 200)
-
-      # Check request url
-      @result = []
-      @gibbon.say_hello(@body) { |res| @result << res }
-      expect(@result).to contain_exactly(@return_items)
-    end
-
-
-  end
-
-  private
-
-  def expect_post(expected_url, expected_body, expected_timeout=30, expected_headers={})
-    expect(Gibbon::APICategory).to receive(:post) { |url, opts|
-      expect(url).to            eq expected_url
-      expect(expected_body).to  eq MultiJson.load(URI::decode(opts[:body]))
-      expect(opts[:timeout]).to eq expected_timeout
-      expect(opts[:headers]).to eq expected_headers
-    }.and_return(Struct.new(:body).new("[]"))
   end
 end
 

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-31 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,15 +58,15 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.0
-description: A wrapper for MailChimp API 2.0 and Export API 1.0
+        version: 3.2.0
+description: A wrapper for MailChimp API 3.0
 email:
 - amromousa@gmail.com
 executables: []
@@ -83,11 +83,10 @@ files:
 - Rakefile
 - gibbon.gemspec
 - lib/gibbon.rb
-- lib/gibbon/api.rb
-- lib/gibbon/api_category.rb
-- lib/gibbon/export.rb
+- lib/gibbon/api_request.rb
 - lib/gibbon/gibbon_error.rb
 - lib/gibbon/mailchimp_error.rb
+- lib/gibbon/request.rb
 - lib/gibbon/version.rb
 - spec/gibbon/gibbon_spec.rb
 - spec/spec_helper.rb
@@ -96,9 +95,9 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: |-
-  IMPORTANT: Gibbon now targets MailChimp API 2.0, which is substantially different from API 1.3.
-                               Please use Gibbon 0.4.6 if you need to use API 1.3.
-  If you're upgrading from <0.5.0 your code WILL break.
+  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.
 rdoc_options: []
 require_paths:
 - lib
@@ -106,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -117,7 +116,7 @@ rubyforge_project: gibbon
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: A wrapper for MailChimp API 2.0 and Export API 1.0
+summary: A wrapper for MailChimp API 3.0
 test_files:
 - spec/gibbon/gibbon_spec.rb
 - spec/spec_helper.rb