banana_bits 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a327d9942e3ca848c69b0f7cf039c042b1a74b07a10f3437bbd0956ff29eaf0
+  data.tar.gz: 7f08f86483403de745e3a90420c6b66f3d77db531a780ea58bb419b47db9e116
+SHA512:
+  metadata.gz: 0ccf352debc6350f8ccabd3ca804ac18ec47381fe5f6b39e5b4d32034e98d20b07c36e5ffc520d2f56b9f7e7e45ebe88f283bf61179ce6ce9c8f37c03b6acd48
+  data.tar.gz: 0c0f828b6bf4b3f998b5feb9e9d55a4f21ebb1ba922e876e9950be13c52b17c507ccea951d8f555eca915fb090bceacb8781b830eb39e455a853e71bda8dc75c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.17.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at james@eightbitstudios.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Changelog.md

@@ -0,0 +1,2 @@
+## [0.2.0] - 2019-09-09
+### Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in banana_bits.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    banana_bits (0.2.0)
+      gibbon (~> 3.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    gibbon (3.2.0)
+      faraday (>= 0.9.1)
+      multi_json (>= 1.11.0)
+    multi_json (1.13.1)
+    multipart-post (2.1.1)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  banana_bits!
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 James Stubblefield
+
+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,78 @@
+# BananaBits
+
+BananaBits simplifies some basic methods that are commonly used to manage Mailchimp members and lists with the [Gibbon gem](https://github.com/amro/gibbon).
+It allows you to get setup subscribing, unsubscribing, and archiving members in minutes.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'banana_bits'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+This gem can be configured with your Mailchimp credentials in an initializer or they can be passed
+in when initializing the client.  You must provide both your API key and the list (audience) id.
+
+```
+BananaBits.configure do |config|
+  config.api_key = 'your_mailchimp_api_key'
+  config.list_id = 'your_mailchimp_list_id'
+end
+```
+
+```
+BananaBits::Client.new(
+  'some@email.com',
+  api_key: 'your_mailchimp_api_key',
+  list_id: 'your_mailchimp_list_id'
+)
+```
+
+### Methods
+
+#### Subscribe
+```
+BananaBits::Client.new('test@example.com).subscribe(
+  {
+    merge_fields: {
+      FNAME: 'Test',
+      LNAME: 'User'
+    }
+  }
+)
+```
+
+#### Unsubscribe
+```
+BananaBits::Client.new('test@example.com).unsubscribe
+```
+
+#### Delete (Archive)
+```
+BananaBits::Client.new('test@example.com).delete
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://bitbucket.org/eightbitdevelopers/banana_bits. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BananaBits project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://bitbucket.org/eightbitdevelopers/banana_bits/src/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/banana_bits.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "banana_bits/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "banana_bits"
+  spec.version       = BananaBits::VERSION
+  spec.authors       = ["James Stubblefield"]
+  spec.email         = ["james@eightbitstudios.com"]
+
+  spec.summary       = %q{A wrapper of commonly used endpoints on Mailchimp}
+  spec.description   = %q{A wrapper of commonly used endpoints on Mailchimp}
+  spec.homepage      = "https://bitbucket.org/eightbitdevelopers/banana_bits"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://bitbucket.org/eightbitdevelopers/banana_bits"
+    spec.metadata["changelog_uri"] = "https://bitbucket.org/eightbitdevelopers/banana_bits/src/master/Changelog.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             'gibbon', '~> 3.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "banana_bits"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/banana_bits.rb

@@ -0,0 +1,23 @@
+require "banana_bits/version"
+require "banana_bits/configuration"
+require "banana_bits/client"
+
+module BananaBits
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset!
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/banana_bits/client.rb

@@ -0,0 +1,76 @@
+require 'gibbon'
+require "banana_bits/concerns/hashable"
+
+module BananaBits
+  class Client
+    include ::BananaBits::Concerns::Hashable
+
+    attr_reader :email, :list_id, :api_key
+
+    def initialize(email, options={})
+      @email = email
+      options = symbolize_keys(options)
+      @api_key = BananaBits.configuration.api_key || options[:api_key]
+      @list_id = BananaBits.configuration.list_id || options[:list_id]
+      check_for_missing_arguments!
+    end
+
+    def subscribe(body={})
+      body.merge! email_address: email, status: 'subscribed'
+      body = remove_blank_values!(body)
+      gibbon_client.lists(list_id).members(hashed_email).upsert(body: body)
+    end
+
+    def unsubscribe
+      gibbon_client.lists(list_id).members(hashed_email).update(
+        body: {
+          status: "unsubscribed"
+        }
+      )
+    end
+
+    def delete
+      gibbon_client.lists(list_id).members(hashed_email).delete
+    end
+
+    private
+
+    def gibbon_client
+      Gibbon::Request.new(api_key: api_key, symbolize_keys: true)
+    end
+
+    def hashed_email
+      Digest::MD5.hexdigest email.downcase
+    end
+
+    # TODO: Add functionality for adding and or pulling down groups
+
+    def group_options(group_name)
+      group = get_group(group_name)
+      group_id = group ? group[:id] : nil
+      get_group_options(group_id)
+    end
+
+    def get_group(group_name)
+      groups = gibbon_client.lists(list_id).interest_categories.retrieve.body
+      groups[:categories].select{ |g| g[:title].downcase == group_name.to_s.downcase }.first
+    end
+
+    def get_group_options(group_id=nil)
+      if group_id
+        options = gibbon_client.lists(list_id).interest_categories(group_id).interests.retrieve.body[:interests]
+        options.inject({}) { |result, interest|  result.merge "#{interest[:name]}" => interest[:id]}
+      else
+        {}
+      end
+    end
+
+    def check_for_missing_arguments!
+      missing = %i(email api_key list_id).select{ |meth| self.public_send(meth).nil? }
+      if missing.any?
+        msg = "Missing required options: #{missing.join(', ')}."
+        raise BananaBits::Error.new(msg)
+      end
+    end
+  end
+end

data/lib/banana_bits/concerns/hashable.rb

@@ -0,0 +1,55 @@
+module BananaBits
+  module Concerns
+    module Hashable
+      def remove_blank_values(collection)
+        if collection.is_a?(Hash)
+          collection.each_with_object({}) do |(k, v), new_hash|
+            if v.empty? && v != false
+              new_hash.delete(k)
+            else
+              if v.is_a?(Hash)
+                new_hash[k] = remove_blank_values(v)
+              elsif v.is_a?(Array)
+                new_hash[k] = remove_blank_values_from_array!(v)
+              else
+                new_hash[k] = v unless collection.empty?
+              end
+            end
+          end
+        elsif collection.is_a?(Array)
+          remove_blank_values_from_array(collection)
+        end
+      end
+
+      def remove_blank_values!(collection)
+        if collection.is_a?(Hash)
+          collection.each_pair do |k, v|
+            if (v.empty? && v != false)
+              collection.delete(k)
+            elsif v.is_a?(Hash)
+              remove_blank_values!(v)
+              collection.delete(k) if collection[k].nil? || collection[k].empty?
+            elsif v.is_a?(Array)
+              remove_blank_values_from_array!(v)
+            end
+          end
+        elsif collection.is_a?(Array)
+          remove_blank_values_from_array!(collection)
+        end
+        return collection
+      end
+
+      def remove_blank_values_from_array(arr)
+        arr.map{|o| remove_blank_values(o)}
+      end
+
+      def remove_blank_values_from_array!(arr)
+        arr.map{|o| remove_blank_values!(o)}
+      end
+
+      def symbolize_keys(collection)
+        collection.inject({}){|result,(k,v)| result[k.to_sym] = v; result}
+      end
+    end
+  end
+end

data/lib/banana_bits/configuration.rb

@@ -0,0 +1,5 @@
+module BananaBits
+  class Configuration
+    attr_accessor :api_key, :list_id
+  end
+end

data/lib/banana_bits/version.rb

@@ -0,0 +1,3 @@
+module BananaBits
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: banana_bits
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- James Stubblefield
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gibbon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A wrapper of commonly used endpoints on Mailchimp
+email:
+- james@eightbitstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Changelog.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- banana_bits.gemspec
+- bin/console
+- bin/setup
+- lib/banana_bits.rb
+- lib/banana_bits/client.rb
+- lib/banana_bits/concerns/hashable.rb
+- lib/banana_bits/configuration.rb
+- lib/banana_bits/version.rb
+homepage: https://bitbucket.org/eightbitdevelopers/banana_bits
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://bitbucket.org/eightbitdevelopers/banana_bits
+  source_code_uri: https://bitbucket.org/eightbitdevelopers/banana_bits
+  changelog_uri: https://bitbucket.org/eightbitdevelopers/banana_bits/src/master/Changelog.md
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A wrapper of commonly used endpoints on Mailchimp
+test_files: []