mailchimp_api_v3 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb3dc62663ec203d2d9e0c0a90bead5dd237422c
-  data.tar.gz: 152265412ea8717fecf81db4477cd98e133e08c3
+  metadata.gz: d8f048d1673768ca49fb00ab3a0b8965c16a8a60
+  data.tar.gz: 98310035ec6e4de642b1d1df78aa1676e7185a53
 SHA512:
-  metadata.gz: 1374abb4143591b1eba1e9698fe116360595298b76a89fd257230e5496282a5b429b0d1a90ba62f53188e179efe17107a4677a04b5ea26b821ff20da6db91451
-  data.tar.gz: acd6b8b0ca5bbac91b6e2158ea267d5d82faff46da2d3943a55d8715e3cca9dea4d9dc8f9b2b56d228654f88784ac8ab9609209b601bf41961e9ce58da734e28
+  metadata.gz: f412aafb47730c2e7c5f4f2ac54586261758bcdec8ad8690fef9e3b6b88a6438ebe1781a2df3ffa25025aee18b1d3eb13c3cb697e9f1a641ac8f0ef121e8c699
+  data.tar.gz: d207f73778a05e6ef54b66884c3d80989a3c3d42ef16263c401767fad0a4af7a52a2e681ac3fbefa8cda3f605517d6ca1ed6c0fa1c2e0cc76dc16b6ed5214092

data/.rubocop.yml

@@ -24,3 +24,16 @@ FileName:
 LineLength:
   Max: 120
   Enabled: true
+
+Style/SymbolArray:
+  Description: 'Use %i or %I for arrays of symbols.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-i'
+  Enabled: false # Only available in Ruby 2.0+
+
+Style/ExtraSpacing:
+  Description: 'Do not use unnecessary spacing.'
+  Enabled: true
+
+Lint/LiteralInInterpolation:
+  Description: 'Avoid interpolating literals in strings'
+  AutoCorrect: true

data/README.md

@@ -1,12 +1,12 @@
 ## Mailchimp API v3
+[![Gem Version](https://badge.fury.io/rb/mailchimp_api_v3.svg)](https://rubygems.org/gems/mailchimp_api_v3)
+[![Gem downloads](https://img.shields.io/gem/dt/mailchimp_api_v3.svg)](https://rubygems.org/gems/mailchimp_api_v3)
+[![Build status](https://img.shields.io/circleci/project/Xenapto/mailchimp_api_v3/develop.svg)](https://circleci.com/gh/Xenapto/mailchimp_api_v3)
+[![Code quality](http://img.shields.io/codeclimate/github/Xenapto/mailchimp_api_v3.svg?style=flat)](https://codeclimate.com/github/Xenapto/mailchimp_api_v3)
+[![Coverage](https://img.shields.io/coveralls/Xenapto/mailchimp_api_v3/develop.svg?style=flat)](https://coveralls.io/r/Xenapto/mailchimp_api_v3?branch=develop)
+[![Dependency Status](https://gemnasium.com/Xenapto/mailchimp_api_v3.svg)](https://gemnasium.com/Xenapto/mailchimp_api_v3)
 
-[![](http://img.shields.io/gem/v/mailchimp_api_v3.svg?style=flat)](https://rubygems.org/gems/mailchimp_api_v3)
-[![](https://img.shields.io/circleci/project/Xenapto/mailchimp_api_v3/develop.svg)](https://circleci.com/gh/Xenapto/mailchimp_api_v3)
-[![](http://img.shields.io/codeclimate/github/Xenapto/mailchimp_api_v3.svg?style=flat)](https://codeclimate.com/github/Xenapto/mailchimp_api_v3)
-[![](https://img.shields.io/coveralls/Xenapto/mailchimp_api_v3/develop.svg?style=flat)](https://coveralls.io/r/Xenapto/mailchimp_api_v3?branch=develop)
-[![](http://img.shields.io/badge/developer-awesome-brightgreen.svg?style=flat)](http://xenapto.com)
-
-A simple gem to interact with Mailchimp through their API v3
+A simple gem to interact with Mailchimp through the Mailchimp API v3
 
 ### Project status
 
@@ -30,7 +30,7 @@ Or install it yourself as:
 
 ### Usage
 
-The Mailchimp API documentation is here: http://kb.mailchimp.com/api. Their suggstions for subscriber management are here: http://kb.mailchimp.com/api/article/how-to-manage-subscribers.
+The Mailchimp API documentation is here: http://kb.mailchimp.com/api. Their suggestions for subscriber management are here: http://kb.mailchimp.com/api/article/how-to-manage-subscribers.
 
 To connect to the Mailchimp API you need to supply an API key. You can do this explicitly when you connect, or you can set an environment variable `MAILCHIMP_API_KEY`.
 
@@ -54,10 +54,13 @@ list = mailchimp.lists.find_by name: 'My first list'
 mailchimp = Mailchimp.connect
 member = mailchimp.lists('e73f5910ca').members('ann@example.com')
 member.name # => "Ann Example"
+member.update last_name: 'Williams'
 ```
 
 ### Contributing
 
+[![Developer](http://img.shields.io/badge/developer-awesome-brightgreen.svg?style=flat)](http://xenapto.com)
+
 1.  Fork it
 1.  Create your feature branch (`git checkout -b my-new-feature`)
 1.  Commit your changes (`git commit -am 'Add some feature'`)

data/lib/mailchimp_api_v3/account.rb

@@ -1,7 +1,5 @@
 module Mailchimp
-  class Account
-    include Instance::InstanceMethods
-
+  class Account < Instance
     def id
       account_id
     end

data/lib/mailchimp_api_v3/client.rb

@@ -1,8 +1,8 @@
-require 'mailchimp_api_v3/exception'
 require 'mailchimp_api_v3/collection'
 require 'mailchimp_api_v3/instance'
+require 'mailchimp_api_v3/exception'
 require 'mailchimp_api_v3/account'
-require 'mailchimp_api_v3/lists'
+require 'mailchimp_api_v3/list'
 require 'mailchimp_api_v3/client/remote'
 
 module Mailchimp

data/lib/mailchimp_api_v3/collection.rb

@@ -1,7 +1,6 @@
-require 'mailchimp_api_v3/collection/paging'
-
 module Mailchimp
-  module Collection
+  class Collection < Array
+    require 'mailchimp_api_v3/collection/paging' # Don't require before class inherits from Array
     include Paging
 
     def initialize(client, parent_path = '', options = {})
@@ -17,7 +16,7 @@ module Mailchimp
     end
 
     def path
-      @path ||= "#{@parent_path}/#{self.class.path_key}"
+      @path ||= "#{@parent_path}/#{self.class::PATH_KEY}"
     end
 
     def where(data, limit = nil)
@@ -40,7 +39,7 @@ module Mailchimp
 
     def create(data)
       response = @client.post data, path
-      self.class.child_class.new @client, response, path
+      self.class::CHILD_CLASS.new @client, response, path
     end
 
     def first_or_create(data)

data/lib/mailchimp_api_v3/collection/paging.rb

@@ -1,5 +1,5 @@
 module Mailchimp
-  module Collection
+  class Collection
     module Paging
       DEFAULT_PAGE_SIZE = 500
 
@@ -9,21 +9,21 @@ module Mailchimp
       end
 
       def fetch_options
-        links_delim = self.class.data_key.empty? ? '' : '.'
+        links_delim = self.class::DATA_KEY.empty? ? '' : '.'
 
         {
-          'exclude_fields' => "#{self.class.data_key}#{links_delim}_links",
+          'exclude_fields' => "#{self.class::DATA_KEY}#{links_delim}_links",
           'offset' => offset,
           'count' => page_size
         }
       end
 
       def page_array
-        @page_array ||= page[self.class.data_key]
+        @page_array ||= page[self.class::DATA_KEY]
       end
 
       def page_children
-        @page_children ||= page_array.map { |d| self.class.child_class.new @client, d, path }
+        @page_children ||= page_array.map { |d| self.class::CHILD_CLASS.new @client, d, path }
       end
 
       def offset

data/lib/mailchimp_api_v3/exception.rb

@@ -23,22 +23,11 @@ module Mailchimp
       end
     end
 
-    class APIKeyError < DataException
-    end
-
-    class Duplicate < DataException
-    end
-
-    class MissingField < DataException
-    end
-
-    class BadRequest < DataException
-    end
-
-    class UnknownAttribute < RuntimeError
-    end
-
-    class MissingId < RuntimeError
-    end
+    APIKeyError = Class.new(DataException)
+    Duplicate = Class.new(DataException)
+    MissingField = Class.new(DataException)
+    BadRequest = Class.new(DataException)
+    UnknownAttribute = Class.new(RuntimeError)
+    MissingId = Class.new(RuntimeError)
   end
 end

data/lib/mailchimp_api_v3/instance.rb

@@ -1,62 +1,62 @@
 module Mailchimp
-  module Instance
-    module InstanceMethods
-      def initialize(client, data, collection_path = '')
-        @client = client
-        @collection_path = collection_path
-        @data = data
-        #- puts @data # debug
-      end
-
-      def update(new_data)
-        @data = @client.patch(new_data, path)
-        self
-      end
+  class Instance
+    # Class methods
 
-      def path
-        @path ||= "#{@collection_path}/#{@data['id']}"
-      end
+    def self.get(client, collection_path, id)
+      data = client.get "#{collection_path}/#{id}"
+      new client, data, collection_path
+    end
 
-      def matches?(match_data)
-        match_data.each do |k, v|
-          break false unless __send__(k).casecmp(v).zero? # case-insensitive comparison
-          true
-        end
-      end
+    # Instance methods
 
-      def subclass_from(collection_class, options = {})
-        if options.is_a? String
-          # Use it as an id for an instance
-          child_path = "#{path}/#{collection_class.path_key}"
-          collection_class.child_class.get @client, child_path, options
-        else
-          # Get the collection
-          collection_class.new @client, path, options
-        end
-      end
+    def initialize(client, data, collection_path = '')
+      @client = client
+      @collection_path = collection_path
+      @data = data
+      #- puts @data # debug
+    end
 
-      private
+    def update(new_data)
+      @data = @client.patch(new_data, path)
+      self
+    end
 
-      attr_reader :data
+    def path
+      @path ||= "#{@collection_path}/#{@data['id']}"
+    end
 
-      def method_missing(symbol, options = {})
-        key = symbol.id2name
-        fail_unless_exists key, options
-        @data[key]
+    def matches?(match_data)
+      match_data.each do |k, v|
+        break false unless __send__(k).casecmp(v).zero? # case-insensitive comparison
+        true
       end
+    end
 
-      def fail_unless_exists(key, options = {})
-        return if @data.key? key
-        message = options == {} ? key : "#{key}: #{options}"
-        fail Mailchimp::Exception::UnknownAttribute, message
+    def subclass_from(collection_class, options = {})
+      if options.is_a? String
+        # Use it as an id for an instance
+        child_path = "#{path}/#{collection_class::PATH_KEY}"
+        collection_class::CHILD_CLASS.get @client, child_path, options
+      else
+        # Get the collection
+        collection_class.new @client, path, options
       end
     end
 
-    module ClassMethods
-      def get(client, collection_path, id)
-        data = client.get "#{collection_path}/#{id}"
-        new client, data, collection_path
-      end
+    private
+
+    attr_reader :data
+
+    def method_missing(symbol, options = {})
+      key = symbol.id2name
+      fail_unless_exists key, options
+      @data[key]
+    end
+
+    def fail_unless_exists(key, options = {})
+      return if @data.key? key
+      message = options == {} ? key : "#{key}: #{options}"
+      fail Mailchimp::Exception::UnknownAttribute, message
     end
   end
 end

data/lib/mailchimp_api_v3/interest.rb

@@ -1,9 +1,11 @@
 module Mailchimp
   class List
     class InterestCategory
-      class Interest
-        include Instance::InstanceMethods
-        extend Instance::ClassMethods
+      Interest = Class.new(Instance)
+
+      class Interests < Collection
+        PATH_KEY = DATA_KEY = 'interests'
+        CHILD_CLASS = Interest
       end
     end
   end

data/lib/mailchimp_api_v3/interest_category.rb

@@ -1,16 +1,14 @@
-require 'mailchimp_api_v3/interests'
-
 module Mailchimp
   class List
-    class InterestCategory
-      #- VALID_TYPES = %w(checkboxes dropdown radio hidden)
-
-      include Instance::InstanceMethods
-      extend Instance::ClassMethods
+    class InterestCategory < Instance
+      require 'mailchimp_api_v3/interest_category/subclasses'
+      include Subclasses
+    end
 
-      def interests(options = {})
-        subclass_from Interests, options
-      end
+    class InterestCategories < Collection
+      PATH_KEY = 'interest-categories'
+      DATA_KEY = 'categories'
+      CHILD_CLASS = InterestCategory
     end
   end
 end

data/lib/mailchimp_api_v3/interest_category/subclasses.rb

@@ -0,0 +1,14 @@
+require 'mailchimp_api_v3/interest'
+
+module Mailchimp
+  class List
+    class InterestCategory
+      module Subclasses
+        #- VALID_TYPES = %w(checkboxes dropdown radio hidden)
+        def interests(options = {})
+          subclass_from Interests, options
+        end
+      end
+    end
+  end
+end

data/lib/mailchimp_api_v3/list.rb

@@ -1,26 +1,15 @@
-require 'mailchimp_api_v3/members'
-require 'mailchimp_api_v3/interest_categories'
-
 module Mailchimp
-  class List
-    include Instance::InstanceMethods
-    extend Instance::ClassMethods
-
-    def members(options = {})
-      # Turn an email into an id
-      if options.is_a?(String) && (options =~ /\A[^@]+@[^@]+\z/)
-        options = OpenSSL::Digest.digest('MD5', options).unpack('H*').first
-      end
-
-      subclass_from Members, options
-    end
-
-    def interest_categories(options = {})
-      subclass_from InterestCategories, options
-    end
+  class List < Instance
+    require 'mailchimp_api_v3/list/subclasses'
+    include Subclasses
 
     def id_and_name
       "#{id}___#{name}"
     end
   end
+
+  class Lists < Collection
+    PATH_KEY = DATA_KEY = 'lists'
+    CHILD_CLASS = List
+  end
 end

data/lib/mailchimp_api_v3/list/subclasses.rb

@@ -0,0 +1,21 @@
+require 'mailchimp_api_v3/member'
+require 'mailchimp_api_v3/interest_category'
+
+module Mailchimp
+  class List
+    module Subclasses
+      def members(options = {})
+        # Turn an email into an id
+        if options.is_a?(String) && (options =~ /\A[^@]+@[^@]+\z/)
+          options = OpenSSL::Digest.digest('MD5', options).unpack('H*').first
+        end
+
+        subclass_from Members, options
+      end
+
+      def interest_categories(options = {})
+        subclass_from InterestCategories, options
+      end
+    end
+  end
+end

data/lib/mailchimp_api_v3/member.rb

@@ -1,9 +1,6 @@
 module Mailchimp
   class List
-    class Member
-      include Instance::InstanceMethods
-      extend Instance::ClassMethods
-
+    class Member < Instance
       def first_name
         @first_name ||= merge_fields['FNAME']
       end
@@ -51,5 +48,10 @@ module Mailchimp
         ]
       end
     end
+
+    class Members < Collection
+      PATH_KEY = DATA_KEY = 'members'
+      CHILD_CLASS = Member
+    end
   end
 end

data/lib/mailchimp_api_v3/version.rb

@@ -1,3 +1,3 @@
 module Mailchimp
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/mailchimp_api_v3.gemspec

@@ -3,18 +3,18 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mailchimp_api_v3/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'mailchimp_api_v3'
-  spec.version       = Mailchimp::VERSION
-  spec.authors       = ['Xenapto']
-  spec.email         = ['developers@xenapto.com']
-  spec.description   = 'A simple gem to interact with Mailchimp through their API v3'
-  spec.summary       = 'Example: mailchimp.lists("My first list").member("ann@example.com")'
-  spec.homepage      = 'https://github.com/Xenapto/mailchimp_api_v3'
-  spec.license       = 'BSD'
+  spec.name = 'mailchimp_api_v3'
+  spec.version = Mailchimp::VERSION
+  spec.authors = ['Xenapto']
+  spec.email = ['developers@xenapto.com']
+  spec.description = 'A simple gem to interact with Mailchimp through their API v3'
+  spec.summary = 'Example: mailchimp.lists("My first list").member("ann@example.com")'
+  spec.homepage = 'https://github.com/Xenapto/mailchimp_api_v3'
+  spec.license = 'BSD'
 
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features|coverage)\/})
+  spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features|coverage)\/})
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'rest-client', '~> 1.6', '> 1.6'

data/spec/mailchimp_api_v3/client_spec.rb

@@ -35,22 +35,35 @@ describe Mailchimp::Client, vcr: { cassette_name: 'mailchimp' } do
     end
   end
 
-  context 'problems we can retry the request for' do
+  context 'exceptions' do
     let(:client) { Mailchimp::Client.new }
 
-    it 'eventually raises the exception' do
-      allow(client).to receive(:remote_no_payload).and_raise SocketError.new('test message')
+    context 'problems we can retry the request for' do
+      it 'eventually raises the exception' do
+        allow(client).to receive(:remote_no_payload).and_raise SocketError.new('test message')
 
-      expect { client.account }.to raise_error { |e|
-        expect(e).to be_an(SocketError)
-        expect(e.message).to eq('test message')
-      }
+        expect { client.account }.to raise_error { |e|
+          expect(e).to be_a(SocketError)
+          expect(e.message).to eq('test message')
+        }
+      end
+
+      it 'only raises the exception after several retries' do
+        allow(client).to receive(:remote_no_payload).twice.and_raise SocketError.new('test message')
+        allow(client).to receive(:remote_no_payload).and_return '"id":1'
+        expect { client.account }.not_to raise_error
+      end
     end
 
-    it 'only raises the exception after several retries' do
-      allow(client).to receive(:remote_no_payload).twice.and_raise SocketError.new('test message')
-      allow(client).to receive(:remote_no_payload).and_return '"id":1'
-      expect { client.account }.not_to raise_error
+    context 'unexpected error' do
+      it 'raises an exception if it encounters an unexpected error' do
+        exception = NotImplementedError.new('test message')
+
+        expect { client.__send__(:managed_remote_exception, exception) }.to raise_error { |e|
+          expect(e).to be_a(NotImplementedError)
+          expect(e.message).to eq('test message')
+        }
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -7,7 +7,7 @@ unless ENV['NO_SIMPLECOV']
     SimpleCov.coverage_dir(dir)
   end
 
-  SimpleCov.start
+  SimpleCov.start { add_filter '/spec/' }
   Coveralls.wear! if ENV['COVERALLS_REPO_TOKEN']
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailchimp_api_v3
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Xenapto
@@ -230,13 +230,11 @@ files:
 - lib/mailchimp_api_v3/exception.rb
 - lib/mailchimp_api_v3/instance.rb
 - lib/mailchimp_api_v3/interest.rb
-- lib/mailchimp_api_v3/interest_categories.rb
 - lib/mailchimp_api_v3/interest_category.rb
-- lib/mailchimp_api_v3/interests.rb
+- lib/mailchimp_api_v3/interest_category/subclasses.rb
 - lib/mailchimp_api_v3/list.rb
-- lib/mailchimp_api_v3/lists.rb
+- lib/mailchimp_api_v3/list/subclasses.rb
 - lib/mailchimp_api_v3/member.rb
-- lib/mailchimp_api_v3/members.rb
 - lib/mailchimp_api_v3/version.rb
 - mailchimp_api_v3.gemspec
 - spec/fixtures/cassettes/mailchimp.yml

data/lib/mailchimp_api_v3/interest_categories.rb

@@ -1,23 +0,0 @@
-require 'mailchimp_api_v3/interest_category'
-
-module Mailchimp
-  class List
-    class InterestCategories < Array
-      include Collection
-
-      class << self
-        def path_key
-          'interest-categories'
-        end
-
-        def data_key
-          'categories'
-        end
-
-        def child_class
-          InterestCategory
-        end
-      end
-    end
-  end
-end

data/lib/mailchimp_api_v3/interests.rb

@@ -1,25 +0,0 @@
-require 'mailchimp_api_v3/interest'
-
-module Mailchimp
-  class List
-    class InterestCategory
-      class Interests < Array
-        include Collection
-
-        class << self
-          def path_key
-            'interests'
-          end
-
-          def data_key
-            'interests'
-          end
-
-          def child_class
-            Interest
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mailchimp_api_v3/lists.rb

@@ -1,21 +0,0 @@
-require 'mailchimp_api_v3/list'
-
-module Mailchimp
-  class Lists < Array
-    include Collection
-
-    class << self
-      def path_key
-        'lists'
-      end
-
-      def data_key
-        'lists'
-      end
-
-      def child_class
-        List
-      end
-    end
-  end
-end

data/lib/mailchimp_api_v3/members.rb

@@ -1,23 +0,0 @@
-require 'mailchimp_api_v3/member'
-
-module Mailchimp
-  class List
-    class Members < Array
-      include Collection
-
-      class << self
-        def path_key
-          'members'
-        end
-
-        def data_key
-          'members'
-        end
-
-        def child_class
-          Member
-        end
-      end
-    end
-  end
-end