mailchimp_api 1.0.0.pre.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb99723d02a7f76f16621524c27aab231833eb8b1f06f5d44377809a6d3dbccd
+  data.tar.gz: e0cd26d1801ba7a088e711cfccce24b9508667b6f657ed131e472c99b3a744c8
+SHA512:
+  metadata.gz: 359bcaa56a36af4145627b393ead3442179e700c746f91191890f27a2c9d293b9cd758103b90e814d46a4d577a18f266a94cdb8bba482b0931f89de16d47f430
+  data.tar.gz: bdffffb268459ac74b5c5c22adb25cb20d17f0f12746fb9209684aff41063d57e79db5c61618e1cd49add201d4abeccfe5bbe3b9d039c0d9b7e670831cedee91

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# CHANGELOG
+
+## [1.0.0]
+
+### Added
+- Support of `/`
+- Support of `/lists`
+- `.count` support

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Third Blink Software Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# MailchimpAPI
+[![Build Status](https://travis-ci.org/rewindio/mailchimp_api.svg?branch=master)](https://travis-ci.org/rewindio/mailchimp_api)
+
+The best way to consume Mailchimp's v3 APIs!
+
+## Installation
+
+###### Add this line to your application's Gemfile
+```ruby
+  gem 'mailchimp_api'
+```
+
+## Usage
+
+###### Basic Account object
+```ruby
+# frozen_string_literal: true
+
+require 'mailchimp_api'
+
+class Account
+  attr_accessor :access_token
+
+  def initialize(access_token)
+    @access_token = access_token
+  end
+
+  def with_mailchimp_session(&block)
+    MailchimpAPI::Session.temp access_token, &block
+  end
+end
+
+account = Account.new 'xxxyyyzzz-us7'
+```
+
+###### GET `/`
+```ruby
+account.with_mailchimp_session { MailchimpAPI::AccountInformation.find '' }
+```
+
+###### GET `/lists`
+```ruby
+account.with_mailchimp_session { MailchimpAPI::List.all }
+```
+
+## Development
+
+After checking out the repository, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rewindio/mailchimp_api.

data/lib/active_resource/connection_ext.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'mailchimp_api/connection'
+
+module ActiveResource
+  class Connection
+    attr_reader :response
+
+    prepend MailchimpAPI::Connection::ResponseCapture
+    prepend MailchimpAPI::Connection::RequestNotification
+  end
+end

data/lib/mailchimp_api/collection_parsers/base.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MailchimpAPI::CollectionParsers
+  class Base < ActiveResource::Collection
+    attr_accessor :total_items, :links
+
+    def initialize(response = {})
+      @links        = instantiate_links response.delete '_links'
+      @total_items  = response.delete 'total_items'
+
+      @elements = response[element_key] || []
+    end
+
+    protected
+
+    def element_key
+      self.class.name.demodulize.downcase.pluralize
+    end
+
+    def instantiate_links(links)
+      links&.map do |link|
+        MailchimpAPI::Link.new link
+      end
+    end
+  end
+end

data/lib/mailchimp_api/collection_parsers/link.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MailchimpAPI::CollectionParsers
+  class Link < Base
+  end
+end

data/lib/mailchimp_api/collection_parsers/list.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MailchimpAPI::CollectionParsers
+  class List < Base
+  end
+end

data/lib/mailchimp_api/collection_parsers.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'mailchimp_api/collection_parsers/base'
+
+Dir.glob("#{File.dirname(__FILE__)}/collection_parsers/*").each { |file| require file if file.end_with? '.rb' }

data/lib/mailchimp_api/configuration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  class Configuration
+    DEFAULT_API_REGION_IDENTIFIER = '__API_REGION_IDENTIFIER__'
+
+    attr_accessor :url
+
+    def initialize
+      # base url
+      @url = "https://#{DEFAULT_API_REGION_IDENTIFIER}.api.mailchimp.com/3.0/"
+    end
+  end
+
+  class << self
+    def configure
+      yield configuration
+
+      MailchimpAPI::Base.site = configuration.url
+
+      configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/lib/mailchimp_api/connection.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  class Connection < ActiveResource::Connection
+    attr_reader :response
+
+    module ResponseCapture
+      def handle_response(response)
+        @response = super
+      end
+    end
+
+    include ResponseCapture
+
+    module RequestNotification
+      def request(method, path, *arguments)
+        super.tap do |response|
+          notify_about_request response, arguments
+        end
+      rescue => e
+        notify_about_request e.response, arguments if e.respond_to? :response
+
+        raise
+      end
+
+      def notify_about_request(response, arguments)
+        ActiveSupport::Notifications.instrument('request.active_resource_detailed') do |payload|
+          payload[:response] = response
+          payload[:data]     = arguments
+        end
+      end
+    end
+
+    include RequestNotification
+  end
+end

data/lib/mailchimp_api/detailed_log_subscriber.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveResource
+  class DetailedLogSubscriber < ActiveSupport::LogSubscriber
+    def request(event)
+      data = event.payload[:data]
+      request_body = data.first
+
+      log_level_method = event.payload[:response].code.to_i < 400 ? :info : :error
+
+      send log_level_method, "Request: #{request_body}" if request_body
+      send log_level_method, "Response: #{event.payload[:response].body}" unless event.payload[:response].header['content-type'] == 'text/html'
+    end
+
+    def logger
+      ActiveResource::Base.logger
+    end
+  end
+end
+
+ActiveResource::DetailedLogSubscriber.attach_to :active_resource_detailed

data/lib/mailchimp_api/exceptions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  class MissingParameter < StandardError
+    def initialize(msg = 'Missing Parameter(s)')
+      super
+    end
+  end
+end

data/lib/mailchimp_api/json_formatter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  class JsonFormatter
+    include ActiveResource::Formats::JsonFormat
+
+    attr_reader :collection_name
+
+    def initialize(collection_name)
+      @collection_name = collection_name.to_s
+    end
+
+    def decode(json)
+      ActiveSupport::JSON.decode json.presence
+    end
+  end
+end

data/lib/mailchimp_api/resources/account_information.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  class AccountInformation < Base
+    self.collection_name  = ''
+    self.element_name     = ''
+
+    class << self
+      def find(*arguments)
+        scope   = arguments.slice!(0)
+        options = arguments.slice!(0) || {}
+
+        prefix_options, query_options = split_options options[:params]
+
+        path = element_path scope, prefix_options, query_options
+
+        instantiate_record format.decode(connection.get(path, headers).body), prefix_options
+      end
+    end
+  end
+end

data/lib/mailchimp_api/resources/base.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  class Base < ActiveResource::Base
+    headers['User-Agent'] = "MailchimpAPI/#{MailchimpAPI::VERSION}"
+    headers['Accept'] = 'application/json'
+    headers['Authorization'] = 'OAuth '
+
+    self.site = MailchimpAPI.configuration.url
+
+    self.include_format_in_path = false
+
+    self.format = MailchimpAPI::JsonFormatter.new :result
+
+    has_many :_links, class_name: 'MailchimpAPI::Link'
+
+    class << self
+      def activate_session(session)
+        self.headers['Authorization'] = "OAuth #{session.oauth_token}" # rubocop:disable Style/RedundantSelf
+
+        MailchimpAPI::Base.site = MailchimpAPI.configuration.url.sub MailchimpAPI::Configuration::DEFAULT_API_REGION_IDENTIFIER, session.api_region_identifier
+      end
+
+      def reset_session
+        self.headers['Authorization'] = 'OAuth ' # rubocop:disable Style/RedundantSelf
+
+        MailchimpAPI::Base.site = MailchimpAPI.configuration.url
+      end
+
+      def headers
+        if _headers_defined?
+          _headers
+        elsif superclass != Object && superclass.headers
+          superclass.headers
+        else
+          _headers || {}
+        end
+      end
+    end
+
+    def to_h
+      JSON.parse(attributes.to_json).symbolize_keys
+    end
+  end
+end

data/lib/mailchimp_api/resources/link.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  class Link < Base
+    self.collection_parser = CollectionParsers::Link
+  end
+end

data/lib/mailchimp_api/resources/list.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  class List < Base
+    extend MailchimpAPI::Support::Countable
+
+    self.collection_parser = CollectionParsers::List
+  end
+end

data/lib/mailchimp_api/resources/support/countable.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MailchimpAPI::Support
+  module Countable
+    def count
+      all(params: { fields: 'total_items', count: 0 }).total_items
+    end
+  end
+end

data/lib/mailchimp_api/resources.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'mailchimp_api/resources/base'
+
+Dir.glob("#{File.dirname(__FILE__)}/resources/support/*").each { |file| require file if file.end_with? '.rb' }
+Dir.glob("#{File.dirname(__FILE__)}/resources/*").each { |file| require file if file.end_with? '.rb' }

data/lib/mailchimp_api/session.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  class Session
+    attr_accessor :oauth_token, :api_region_identifier
+
+    def initialize(oauth_token)
+      self.oauth_token            = oauth_token
+      self.api_region_identifier  = oauth_token&.split('-')&.last || MailchimpAPI::Configuration::DEFAULT_API_REGION_IDENTIFIER
+    end
+
+    class << self
+      def temp(oauth_token)
+        session = new oauth_token
+
+        MailchimpAPI::Base.activate_session session
+
+        yield
+      ensure
+        MailchimpAPI::Base.reset_session
+      end
+    end
+  end
+end

data/lib/mailchimp_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  VERSION = '1.0.0.pre.0'
+end

data/lib/mailchimp_api.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+# gem requires
+require 'activeresource'
+
+# gem extensions
+require 'active_resource/connection_ext'
+
+require 'mailchimp_api/version'
+require 'mailchimp_api/configuration'
+
+module MailchimpAPI
+end
+
+require 'mailchimp_api/json_formatter'
+require 'mailchimp_api/connection'
+require 'mailchimp_api/detailed_log_subscriber'
+require 'mailchimp_api/exceptions'
+require 'mailchimp_api/session'
+
+require 'mailchimp_api/collection_parsers'
+require 'mailchimp_api/resources'

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: mailchimp_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.0
+platform: ruby
+authors:
+- rewind.io
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: http_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.0
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+description: Consume Mailchimp's API using ActiveResource
+email:
+- team@rewind.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/active_resource/connection_ext.rb
+- lib/mailchimp_api.rb
+- lib/mailchimp_api/collection_parsers.rb
+- lib/mailchimp_api/collection_parsers/base.rb
+- lib/mailchimp_api/collection_parsers/link.rb
+- lib/mailchimp_api/collection_parsers/list.rb
+- lib/mailchimp_api/configuration.rb
+- lib/mailchimp_api/connection.rb
+- lib/mailchimp_api/detailed_log_subscriber.rb
+- lib/mailchimp_api/exceptions.rb
+- lib/mailchimp_api/json_formatter.rb
+- lib/mailchimp_api/resources.rb
+- lib/mailchimp_api/resources/account_information.rb
+- lib/mailchimp_api/resources/base.rb
+- lib/mailchimp_api/resources/link.rb
+- lib/mailchimp_api/resources/list.rb
+- lib/mailchimp_api/resources/support/countable.rb
+- lib/mailchimp_api/session.rb
+- lib/mailchimp_api/version.rb
+homepage: https://github.com/rewindio/mailchimp_api.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Consume Mailchimp's API using ActiveResource
+test_files: []