mailchimp_api_v3 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cea605da8196d54280fa8b3b52f804643720a4cc
+  data.tar.gz: 9adf62426b975cf8f73e98a52f571a04fe335b57
+SHA512:
+  metadata.gz: 5aa0078062716c9af0a986c84669a29eebc2cf982f5de986016b23a70a19e3aa6e19bcb3b8608fd254109f48614b736f86602183c8f24eab4086d77db5e9440b
+  data.tar.gz: 5fc82ff959426f5d6ad832747301c6bdf536feeaf95d080645f2ef0b5c6c565a71268e7b5c3bed8f2764f2448f2e7bcc030954b3d7f88677380dc18b16811632

data/.gitignore

@@ -0,0 +1,38 @@
+# Put your test API key in this file:
+api_key.yml
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.hound.yml

@@ -0,0 +1,4 @@
+---
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,26 @@
+---
+StringLiterals:
+  EnforcedStyle: single_quotes
+  Enabled: true
+
+DotPosition:
+  Description: 'Checks the position of the dot in multi-line method calls.'
+  EnforcedStyle: leading
+  Enabled: true
+
+ClassAndModuleChildren:
+  Description: 'Checks style of children classes and modules.'
+  EnforcedStyle: nested
+  Enabled: true
+
+Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+FileName:
+  Description: 'Use snake_case for source file names.'
+  Enabled: true
+
+LineLength:
+  Max: 120
+  Enabled: true

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+### Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.1.0, available at [http://contributor-covenant.org/version/1/1/0/](http://contributor-covenant.org/version/1/1/0/)

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard(
+  :rspec,
+  all_after_pass: true,
+  all_on_start: true,
+  cmd: 'NO_SIMPLECOV=true bundle exec rspec --fail-fast --format documentation'
+) do
+  watch(%r{spec/.+_spec\.rb$})
+  watch(%r{lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^spec/support/.+\.rb$}) { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,29 @@
+Copyright (c) 2015, Xenapto
+Some code copyright (c) 2015, The Rocket Science Group, LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of mailchimp_api_v3 nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,44 @@
+## Mailchimp API v3
+
+![Gem Version(https://rubygems.org/gems/mailchimp_api_v3)](http://img.shields.io/gem/v/mailchimp_api_v3.svg?style=flat)
+![build status(https://circleci.com/gh/Xenapto/mailchimp_api_v3)](https://img.shields.io/circleci/project/Xenapto/mailchimp_api_v3/develop.svg)
+[![Code Climate](http://img.shields.io/codeclimate/github/Xenapto/mailchimp_api_v3.svg?style=flat)](https://codeclimate.com/github/Xenapto/mailchimp_api_v3)
+[![Coverage Status](https://img.shields.io/coveralls/Xenapto/mailchimp_api_v3/develop.svg?style=flat)](https://coveralls.io/r/Xenapto/mailchimp_api_v3?branch=develop)
+[![Developer status](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
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mailchimp_api_v3'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mailchimp_api_v3
+
+### Usage
+
+Examples:
+
+```ruby
+Mailchimp.connect(mc_key).lists
+```
+
+### Contributing
+
+1.  Fork it
+1.  Create your feature branch (`git checkout -b my-new-feature`)
+1.  Commit your changes (`git commit -am 'Add some feature'`)
+1.  Push to the branch (`git push origin my-new-feature`)
+1.  Create new Pull Request
+
+### Acknowledgements
+
+I used the sample code in https://github.com/mailchimp/APIv3-examples as my starting point for this gem. Thanks to
+the Mailchimp developers for the head start.

data/lib/mailchimp.rb

@@ -0,0 +1,8 @@
+require 'mailchimp/version'
+require 'mailchimp/client'
+
+module Mailchimp
+  def self.connect(api_key = nil)
+    Client.new api_key
+  end
+end

data/lib/mailchimp/account.rb

@@ -0,0 +1,14 @@
+module Mailchimp
+  class Account
+    PATH_KEY = DATA_KEY = ''
+    include Instance
+
+    def id
+      account_id
+    end
+
+    def name
+      account_name
+    end
+  end
+end

data/lib/mailchimp/client.rb

@@ -0,0 +1,44 @@
+require 'mailchimp/exception'
+require 'mailchimp/collection'
+require 'mailchimp/instance'
+require 'mailchimp/account'
+require 'mailchimp/lists'
+require 'mailchimp/client/remote'
+
+module Mailchimp
+  class Client
+    include Remote
+
+    def account
+      Account.new self, get
+    end
+
+    def lists
+      Lists.new self
+    end
+
+    def connected?
+      account
+    rescue Mailchimp::Exception::APIKeyError
+      false
+    else
+      true
+    end
+
+    private
+
+    def initialize(api_key = nil, extra_headers = {})
+      @api_key = api_key || ENV['MAILCHIMP_API_KEY']
+      fail Mailchimp::Exception::APIKeyError, 'title' => 'Invalid API key format' unless api_key_valid?
+      @extra_headers = extra_headers
+    end
+
+    def api_key_valid?
+      @api_key =~ /\w+-\w{3}/
+    end
+
+    def dc
+      @dc ||= @api_key.split('-')[1]
+    end
+  end
+end

data/lib/mailchimp/client/remote.rb

@@ -0,0 +1,79 @@
+require 'yaml'
+require 'restclient'
+
+module Mailchimp
+  class Client
+    module Remote
+      def get(path = '', options = {})
+        managed_remote path, options, :get
+      end
+
+      def post(data, path = '', options = {})
+        managed_remote path, options, :post, data
+      end
+
+      def patch(data, path = '', options = {})
+        managed_remote path, options, :patch, data
+      end
+
+      private
+
+      RETRY_EXCEPTIONS = [SocketError]
+
+      def managed_remote(path = '', options = {}, method = :get, payload = nil)
+        headers_and_params = headers.merge params_from(options)
+        url = "#{url_stub}#{path}"
+        # puts url # debug
+        YAML.load naked_remote(url, method, headers_and_params, payload)
+      rescue *RETRY_EXCEPTIONS => e
+        @retries ||= 0
+        raise e if (@retries += 1) > 3
+        retry
+      rescue => e # TODO: Find out why this doesn't fire if we rescue RestClient::Exception
+        managed_remote_exception e
+      end
+
+      def managed_remote_exception(e)
+        case e.class.to_s # TODO: Find out why this won't match the class except by name string
+        when 'RestClient::Unauthorized'
+          fail Mailchimp::Exception::APIKeyError, YAML.load(e.http_body)
+        when 'RestClient::BadRequest'
+          Mailchimp::Exception.parse_invalid_resource_exception YAML.load(e.http_body)
+        else
+          fail e
+        end
+      end
+
+      def naked_remote(url, method, headers_and_params, payload = nil)
+        if [:get, :delete, :head, :options].include? method
+          remote_no_payload(url, method, headers_and_params)
+        else
+          remote_with_payload(url, payload, method, headers_and_params)
+        end
+      end
+
+      def remote_no_payload(url, method = :get, headers_and_params = {})
+        RestClient.__send__ method, url, headers_and_params
+      end
+
+      def remote_with_payload(url, payload, method = :post, headers_and_params = {})
+        RestClient.__send__ method, url, payload.to_json, headers_and_params
+      end
+
+      def headers
+        @headers ||= {
+          'Authorization' => "apikey #{@api_key}",
+          'User-Agent' => 'Mailchimp API v3 Ruby gem https://rubygems.org/gems/mailchimp_api_v3'
+        }.merge @extra_headers
+      end
+
+      def url_stub
+        @url_stub ||= "https://#{dc}.api.mailchimp.com/3.0"
+      end
+
+      def params_from(options = {})
+        options == {} ? {} : { 'params' => options }
+      end
+    end
+  end
+end

data/lib/mailchimp/collection.rb

@@ -0,0 +1,45 @@
+require 'mailchimp/collection/paging'
+
+module Mailchimp
+  module Collection
+    include Paging
+
+    def initialize(client, parent_path = '', options = {})
+      @client = client
+      @parent_path = parent_path
+
+      parse_options(options)
+      super page_children
+    end
+
+    def count
+      page['total_items']
+    end
+
+    def path
+      @path ||= "#{@parent_path}/#{self.class.path_key}"
+    end
+
+    def find(data)
+      find_each do |instance|
+        matches = data.each do |k, v|
+          break false unless instance.__send__(k).casecmp(v).zero? # case-insensitive comparison
+          true
+        end
+
+        break instance if matches
+      end
+    end
+
+    def create(data)
+      response = @client.post data, path
+      self.class.child_class.new @client, response, path
+    end
+
+    def first_or_create(data)
+      instance = find(data)
+      return instance if instance
+      create(data)
+    end
+  end
+end

data/lib/mailchimp/collection/paging.rb

@@ -0,0 +1,70 @@
+module Mailchimp
+  module Collection
+    module Paging
+      DEFAULT_PAGE_SIZE = 500
+
+      def page
+        return @page if @page
+        @page = @client.get(path, fetch_options)
+      end
+
+      def fetch_options
+        links_delim = self.class.data_key.empty? ? '' : '.'
+
+        {
+          '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]
+      end
+
+      def page_children
+        @page_children ||= page_array.map { |d| self.class.child_class.new @client, d, path }
+      end
+
+      def offset
+        @offset ||= 0
+      end
+
+      def page_size
+        @page_size ||= DEFAULT_PAGE_SIZE
+      end
+
+      def find_in_pages(options = {})
+        parse_options(options)
+
+        loop do
+          yield page_children
+          @offset += page_size
+
+          if offset > count
+            @offset = 0
+            break
+          end
+
+          invalidate_current_page
+        end
+      end
+
+      def find_each
+        find_in_pages do |p|
+          p.each { |child| yield child }
+        end
+      end
+
+      def parse_options(options = {})
+        @offset = options['start'] if options.key? 'start'
+        @page_size = options['page_size'] if options.key? 'page_size'
+        invalidate_current_page
+      end
+
+      def invalidate_current_page
+        @page = @page_array = @page_children = nil
+      end
+    end
+  end
+end