eventbrite_contacts 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59b1cf1ae83578e7798ba960a7cdb1c2731a6c16
+  data.tar.gz: 38ff07010221ee818fc17d08072f780f9415e012
+SHA512:
+  metadata.gz: 95c9200659672676fce03e0c40d3c4575e39642a9c84c9dbb34442f8f8d424749360fc7d5f97a40ee1f1793927635bafd5a2bdf30e0f0d97582ad11295068dba
+  data.tar.gz: 03582c6420edca72328b0bc502424ebf46d6e9e0b032be8780d9dc5d578746ab2dcbdcca42f139da77d6b9a9eaa37962a0c40a1cc8f2d064547243a49124e1d9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# 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, 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.
+
+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.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eventbrite_contacts.gemspec
+gemspec

data/README.md

@@ -0,0 +1,110 @@
+# EventbriteContacts
+
+Interact with the Eventbrite API to get, create and delete Contacts and Lists
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eventbrite_contacts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eventbrite_contacts
+
+## Usage
+
+The Eventbrie API authenticates a user using Oauth2 so an Oauth token must be
+obtained. An Oauth stragey, such as the gem **omniauth-eventbrite** can be used to return
+the Eventbrite Oauth token
+
+Instantiate a client:
+
+```ruby
+client = ::EventbriteContacts::Client.new("my_eventbrite_token", "my_eventbrite_user_id")
+```
+
+Call the following methods on the client. options={} is an optional parameter in methods that
+  return a paginated response. If no argument is given the default page returned will be 1.
+  Supply the page in the following format:
+
+```ruby
+{page: 3}
+```
+
+To get a users contact lists
+
+```ruby
+client.get_lists(options={})
+```
+
+To get a specific list
+
+```ruby
+client.get_list("my_list_id")
+```
+
+To add a new list
+
+```ruby
+client.add_list("my_new_list_name")
+```
+
+To delete a list
+
+```ruby
+client.delete_list("my_list_id")
+```
+
+To return all the contacts in a list. The response is an array of hashes
+
+```ruby
+client.get_all_contacts("my_list_id")
+```
+
+To get a paginated response of contacts in a list
+
+```ruby
+client.get_contacts("my_list_id", options={})
+```
+
+To add a contact to a list
+
+```ruby
+client.add_contact("my_list_id", contact)
+```
+
+Where contact is a hash with the following attributes:
+
+```ruby
+{
+  email: "eric@cantona.com",
+  first_name: "Eric",
+  last_name: "Cantona"
+}
+```
+
+To delete a contact
+
+```ruby
+client.delete_contact("my_list_id", "eric@cantona.com")
+```
+
+There is currently no option to update with the Eventbrite API. Their docs recommend to first
+delete and then add a list or contact in order to update
+
+For reference: https://www.eventbrite.com/developer/v3/quickstart/
+
+## Contributing
+
+1. Fork it ( https://github.com/cjlofts/eventbrite_contacts/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eventbrite_contacts"
+
+# 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

data/bin/setup

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

data/eventbrite_contacts.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eventbrite_contacts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eventbrite_contacts"
+  spec.version       = EventbriteContacts::Client::VERSION
+  spec.authors       = ["Ciaran Lofts"]
+  spec.email         = ["ciaran@wishpond.com"]
+  spec.description   = %q{Create and remove Eventbrite contacts}
+
+  spec.summary       = %q{Interact with the Eventbrite API to create Contact Lists and retrieve, create and delete Contacts}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  end
+
+  spec.add_dependency 'httparty'
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+end

data/lib/eventbrite_contacts/version.rb

@@ -0,0 +1,5 @@
+module EventbriteContacts
+  class Client
+    VERSION = "0.1.1"
+  end
+end

data/lib/eventbrite_contacts.rb

@@ -0,0 +1,104 @@
+require 'eventbrite_contacts/version'
+require 'httparty'
+
+module EventbriteContacts
+  RateLimitExceeded = Class.new(StandardError)
+  class Client
+
+  BASE_URL = "https://www.eventbriteapi.com/v3/"
+
+  def initialize(auth_token, user_id)
+    @auth_token = auth_token
+    @user_id = user_id
+  end
+
+  def get_lists(options={})
+    url = "#{BASE_URL}users/#{@user_id}/contact_lists/?"
+    page = if options[:page].nil? then 1 else options[:page] end
+    encoded = URI.encode("#{url}page=#{page}")
+    response = make_request(encoded, "get")
+    raise_limit_error(response)
+  end
+
+  def get_list(list_id)
+    url = "#{BASE_URL}users/#{@user_id}/contact_lists/#{list_id}"
+    encoded = URI.encode(url)
+    response = make_request(encoded, "get")
+    raise_limit_error(response)
+  end
+
+  def add_list(list_name)
+    url = "#{BASE_URL}users/#{@user_id}/contact_lists/?"
+    encoded = URI.encode("#{url}contact_list.name=#{list_name}")
+    response = make_request(encoded, "post")
+    raise_limit_error(response)
+  end
+
+  def delete_list(list_id)
+    url = "#{BASE_URL}users/#{@user_id}/contact_lists/#{list_id}"
+    encoded = URI.encode(url)
+    response = make_request(encoded, "delete")
+    raise_limit_error(response)
+  end
+
+  def get_all_contacts(list_id)
+    url = "#{BASE_URL}users/#{@user_id}/contact_lists/#{list_id}/contacts"
+    page = 1
+    contacts = []
+    loop do
+      encoded = URI.encode("#{url}?page=#{page}")
+      response = make_request(encoded, "get")
+      raise_limit_error(response)
+      contacts << response["contacts"] unless response["contacts"].nil?
+      page += 1
+      break if response["error"] == "BAD_PAGE"
+    end
+    contacts.flatten
+  end
+
+  def get_contacts(list_id, options={})
+    url = "#{BASE_URL}users/#{@user_id}/contact_lists/#{list_id}/contacts?"
+    page = if options[:page].nil? then 1 else options[:page] end
+    encoded = URI.encode("#{url}page=#{page}")
+    response = make_request(encoded, "get")
+    raise_limit_error(response)
+  end
+
+  def add_contact(list_id, contact)
+    url = "#{BASE_URL}users/#{@user_id}/contact_lists/#{list_id}/contacts/?"
+    param_url = "contact.email=#{contact[:email]}&contact.first_name=#{contact[:first_name]}&contact.last_name=#{contact[:last_name]}"
+    encoded = URI.encode("#{url}#{param_url}")
+    response = make_request(encoded, "post")
+    raise_limit_error(response)
+  end
+
+  def delete_contact(list_id, contact_email)
+    url = "#{BASE_URL}users/#{@user_id}/contact_lists/#{list_id}/contacts/?"
+    encoded = URI.encode("#{url}email=#{contact_email}")
+    response = make_request(encoded, "delete")
+    raise_limit_error(response)
+  end
+
+  private
+
+  def make_request(url, verb)
+    case verb
+    when "get"
+      HTTParty.get(url, :headers => { "Authorization" => "Bearer #{@auth_token}" })
+    when "post"
+      HTTParty.post(url, :headers => { "Authorization" => "Bearer #{@auth_token}" })
+    when "delete"
+      HTTParty.delete(url, :headers => { "Authorization" => "Bearer #{@auth_token}" })
+    end
+  end
+
+  def raise_limit_error(response)
+    if response["error"] == "HIT_RATE_LIMIT"
+      raise RateLimitExceeded, "rate_limit_exceeded"
+    else
+      response
+    end
+  end
+
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: eventbrite_contacts
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ciaran Lofts
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create and remove Eventbrite contacts
+email:
+- ciaran@wishpond.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eventbrite_contacts.gemspec
+- lib/eventbrite_contacts.rb
+- lib/eventbrite_contacts/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Interact with the Eventbrite API to create Contact Lists and retrieve, create
+  and delete Contacts
+test_files: []