eventbrite_sdk 3.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aef4bd7cbff3bc00c26d9ad6a8464a63a32e5f49
+  data.tar.gz: 07698a50a146d4064efaa277d8751b6b304874da
+SHA512:
+  metadata.gz: 8208735f81b9f03f58f19758b278427ffd733aad34af65e6ed3c3d9711ecbe56d1f4eb4732ce031c017047e043ce5bcab842088718ec9a8cf881d371f93d07a4
+  data.tar.gz: 3751f3956c63b5de6850d959d6314ac59ce2485cbcdebd3601a155328083e0cfd867dbf4c025813e7ce85138f55eea3aa0c05a57a77b42e4f23aac5675b79480

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+coverage/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5
+after_success:
+  - bundle exec codeclimate-test-reporter

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eventbrite_sdk.gemspec
+gemspec
+
+gem 'rest-client', '~> 2.0.0'
+
+group :development do
+  gem 'rspec', '~> 3.5.0'
+  gem 'byebug', '~> 9.0.6'
+  gem 'webmock', '~> 2.3.2'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vinnie Franco
+
+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,136 @@
+# EventbriteSdk
+
+[![Code Climate](https://codeclimate.com/github/eventbrite/eventbrite-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/eventbrite/eventbrite-sdk-ruby) [![Issue Count](https://codeclimate.com/github/eventbrite/eventbrite-sdk-ruby/badges/issue_count.svg)](https://codeclimate.com/github/eventbrite/eventbrite-sdk-ruby) [![Build Status](https://travis-ci.org/eventbrite/eventbrite-sdk-ruby.svg?branch=master)](https://travis-ci.org/eventbrite/eventbrite-sdk-ruby) [![Test Coverage](https://codeclimate.com/github/eventbrite/eventbrite-sdk-ruby/badges/coverage.svg)](https://codeclimate.com/github/eventbrite/eventbrite-sdk-ruby/coverage) [![Dependency Status](https://gemnasium.com/badges/github.com/eventbrite/eventbrite-sdk-ruby.svg)](https://gemnasium.com/github.com/eventbrite/eventbrite-sdk-ruby) [![Gem Version](https://badge.fury.io/rb/eventbrite_sdk.svg)](https://badge.fury.io/rb/eventbrite_sdk)
+
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/eventbrite_sdk`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eventbrite_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eventbrite_sdk
+
+## Usage
+
+The library needs to be configured with your account's personal OAuth token which is available in your [App Management][app management] page. Assign it's value to `EventbriteSDK.token` and the library will send it along automatically with every request.
+
+# Basic usage for creating/retrieving/updating/publishing an event:
+
+``` ruby
+
+EventbriteSDK.token = "TOKEN"
+
+# create an event draft
+your_event = EventbriteSDK::Event.build('name.html' => 'Event Name', 'start.utc' => '2018-01-31T13:00:00Z', 'start.timezone' => 'America/Los_Angeles', 'end.utc' => '2018-02-01T13:00:00Z', 'end.timezone' => 'America/Los_Angeles', 'currency' => 'USD')
+
+your_event.save
+# => true
+
+# retrieve your event
+your_event
+
+# retrieve one field on the object
+your_event.id
+
+# retrieve any event by id
+EventbriteSDK::Event.retrieve(id: 20955468370)
+
+# update the event
+your_event.assign_attributes('name.html' => 'A new name', 'description.html' => 'A new description')
+
+your_event.save
+# =>true
+
+# add ticket classes to the event
+event_ticket = EventbriteSDK::TicketClass.new(event_id: your_event.id)
+event_ticket.assign_attributes('name'=>'Ticket Name', 'cost'=>'USD,3400', 'quantity_total'=>'378')
+
+event_ticket.save
+
+# to see if the event is 'dirty' (i.e. has unsaved changes)
+your_event.changed?
+# =>true
+
+# save the changes
+your_event.save
+
+# publish the event
+your_event.publish
+
+```
+# Navigating paginated responses:
+
+``` ruby
+
+EventbriteSDK.token = "TOKEN"
+
+# one feature of the Eventbrite API is that you can pass in the string 'me' in place of a 
+# user id and it will evaluate to the id of the user associated with the oauth token.
+
+# fetch a new user record using the Eventbrite user id
+user = EventbriteSDK::User.retrieve(id: 163054428874)
+
+# get one page of your events
+events = user.owned_events.page(2)
+
+# not providing a page number will default to page one
+events = user.owned_events.page(1) => events = user.owned_events
+
+# events is now an enumerable object that you can access using bracket notation or first/last
+events.first => events[0]
+events.last => events[-1]
+
+```
+# Construct endpoint paths:
+
+``` ruby
+
+EventbriteSDK.token = "TOKEN"
+
+# access this endpoint www.eventbriteapi.com/v3/events/:id/ticket_classes/:id/
+ticket = EventbriteSDK::TicketClass.retrieve(event_id: 20928651159, id: 43892783)
+
+```
+# Use expansions
+
+``` ruby
+
+EventbriteSDK.token = "TOKEN"
+
+# get an order with attendees expanded
+
+order = EventbriteSDK::Order.retrieve(id: id, expand: [:attendees])
+
+# include multiple expansions in one request
+
+order = EventbriteSDK::Order.retrieve(id: id, expand: [:attendees, :event])
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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://github.com/eventbrite/eventbrite-sdk-ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'eventbrite_sdk'
+
+# 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'
+require 'irb/completion'
+
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/eventbrite_sdk.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eventbrite_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'eventbrite_sdk'
+  spec.version       = EventbriteSDK::VERSION
+  spec.authors       = ['Vinnie Franco', 'Jeff McKenzie', 'Emilio Tagua']
+  spec.email         = ['vinnie@eventbrite.com', 'jeffm@eventbrite.com', 'emilio@eventbrite.com']
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.summary       = %{Official Eventbrite SDK for the v3 API}
+  spec.description   = %{Official Eventbrite SDK for the v3 API}
+  spec.homepage      = "https://github.com/eventbrite"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rest-client'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+end

data/lib/eventbrite_sdk.rb

@@ -0,0 +1,135 @@
+require 'json'
+require 'set'
+require 'rest_client'
+
+require 'eventbrite_sdk/version'
+require 'eventbrite_sdk/exceptions'
+require 'eventbrite_sdk/resource/operations/attribute_schema'
+require 'eventbrite_sdk/resource/operations/list'
+require 'eventbrite_sdk/resource/operations/endpoint'
+require 'eventbrite_sdk/resource/operations/relationships'
+require 'eventbrite_sdk/resource/attributes'
+require 'eventbrite_sdk/resource/null_schema_definition'
+require 'eventbrite_sdk/resource/schema_definition'
+require 'eventbrite_sdk/resource_list'
+require 'eventbrite_sdk/resource'
+
+require 'eventbrite_sdk/lists/owned_event_orders_list'
+
+require 'eventbrite_sdk/attendee'
+require 'eventbrite_sdk/category'
+require 'eventbrite_sdk/event'
+require 'eventbrite_sdk/media'
+require 'eventbrite_sdk/order'
+require 'eventbrite_sdk/organizer'
+require 'eventbrite_sdk/report'
+require 'eventbrite_sdk/subcategory'
+require 'eventbrite_sdk/ticket_class'
+require 'eventbrite_sdk/user'
+require 'eventbrite_sdk/venue'
+require 'eventbrite_sdk/webhook'
+
+module EventbriteSDK
+  BASE = "https://www.eventbriteapi.com/v#{VERSION.split('.').first}".freeze
+  EXCEPTION_MAP = {
+    RestClient::ResourceNotFound => {
+      class: ResourceNotFound,
+      message: 'requested object was not found',
+    },
+    RestClient::BadRequest => {
+      class: BadRequest,
+      message: 'invalid request',
+    },
+    RestClient::Forbidden => {
+      class: Forbidden,
+      message: 'not authorized',
+    },
+    RestClient::InternalServerError => {
+      class: InternalServerError,
+      message: 'internal server error',
+    },
+    RestClient::Unauthorized => {
+      class: Unauthorized,
+      message: 'unauthorized request',
+    }
+  }.freeze
+  THREAD_EB_API_TOKEN_KEY = :eb_api_token
+  VERIFY_SSL = true
+
+  def self.token
+    Thread.current[THREAD_EB_API_TOKEN_KEY]
+  end
+
+  def self.token=(api_token)
+    Thread.current[THREAD_EB_API_TOKEN_KEY] = api_token
+  end
+
+  def self.base_url
+    @base_url || BASE
+  end
+
+  def self.base_url=(url)
+    @base_url = url
+  end
+
+  def self.verify_ssl?
+    if @verify_ssl.nil?
+      VERIFY_SSL
+    else
+      @verify_ssl
+    end
+  end
+
+  def self.verify_ssl=(verifies)
+    @verify_ssl = verifies
+  end
+
+  def self.get(params)
+    params[:headers] = { 'Accept' => 'application/json' }
+    params[:method] = :get
+
+    request(params)
+  end
+
+  def self.post(params)
+    params[:headers] = { 'Content-Type' => 'application/json' }
+    params[:method] = :post
+
+    # Don't convert nil to json.
+    #
+    # BadRequest is raised when you publish an event because the body sent is
+    # "null" (invalid json) and the API rejects it.
+    if params[:payload]
+      params[:payload] = params[:payload].to_json
+    end
+
+    request(params)
+  end
+
+  def self.delete(params)
+    params[:headers] = { 'Accept' => 'application/json' }
+    params[:method] = :delete
+
+    request(params)
+  end
+
+  def self.request(params)
+    query = params.delete(:query)
+
+    params[:url] = url(params[:url].gsub(/\/$/, ''))
+    params[:headers]['Authorization'] = "Bearer #{token}" if token
+    params[:headers][:params] = query if query
+    params[:verify_ssl] = verify_ssl?
+
+    response = RestClient::Request.execute(params)
+
+    JSON.parse(response.body) unless response.body == ''
+  rescue *EXCEPTION_MAP.keys => err
+    handler = EXCEPTION_MAP[err.class]
+    raise handler[:class].new(handler[:message], err.response)
+  end
+
+  def self.url(path)
+    "#{base_url}/#{path}/"
+  end
+end

data/lib/eventbrite_sdk/attendee.rb

@@ -0,0 +1,26 @@
+module EventbriteSDK
+  class Attendee < Resource
+    resource_path 'orders/:order_id/attendees/:id'
+
+    belongs_to :order, object_class: 'Order'
+
+    has_many :attendees, object_class: 'Attendee'
+
+    schema_definition do
+      string 'event_id'
+      string 'order_id'
+      string 'ticket_class_id'
+      string 'ticket_class_name'
+      string 'status'
+      boolean 'refunded'
+      boolean 'cancelled'
+      boolean 'checked_in'
+      integer 'quantity'
+      string 'profile'
+      string 'costs'
+      datetime 'created', read_only: true
+      datetime 'changed', read_only: true
+      string 'resource_uri', read_only: true
+    end
+  end
+end

data/lib/eventbrite_sdk/category.rb

@@ -0,0 +1,14 @@
+module EventbriteSDK
+  class Category < Resource
+    extend Operations::List
+
+    resource_path 'categories/:id'
+
+    schema_definition do
+      string 'name', read_only: true
+      string 'name_localized', read_only: true
+      string 'short_name', read_only: true
+      string 'subcategories', read_only: true
+    end
+  end
+end

data/lib/eventbrite_sdk/event.rb

@@ -0,0 +1,75 @@
+module EventbriteSDK
+  class Event < Resource
+    ERROR_CANNOT_PUBLISH = 'CANNOT_UNPUBLISH'.freeze
+    ERROR_ALREADY_PUBLISHED_OR_DELETED = 'ALREADY_PUBLISHED_OR_DELETED'.freeze
+
+    # Defines event#cancel, event#publish, and event#unpublish
+    #
+    # When an event has an id the POST is made, otherwise we return false
+    # POSTS to event/:id/(cancel|publish|unpublish)
+    define_api_actions :cancel, :publish, :unpublish
+
+    resource_path 'events/:id'
+
+    attributes_prefix 'event'
+
+    belongs_to :organizer, object_class: 'Organizer'
+    belongs_to :venue, object_class: 'Venue'
+
+    has_many :orders, object_class: 'Order'
+    has_many :ticket_classes, object_class: 'TicketClass'
+
+    schema_definition do
+      string 'name.html'
+      string 'description.html'
+      string 'organizer_id'
+      datetime 'start.utc'
+      datetime 'start.timezone'
+      datetime 'end.utc'
+      datetime 'end.timezone'
+      boolean 'hide_start_date'
+      boolean 'hide_end_date'
+      string 'currency'
+      string 'venue_id'
+      boolean 'online_event'
+      boolean 'listed'
+      string 'logo_id'
+      string 'category_id'
+      string 'subcategory_id'
+      string 'format_id'
+      boolean 'shareable'
+      boolean 'invite_only'
+      string 'password'
+      integer 'capacity'
+      boolean 'show_remaining'
+      string 'source'
+      string 'status', read_only: true
+      string 'created', read_only: true
+      string 'changed', read_only: true
+      string 'resource_uri', read_only: true
+    end
+
+    def self.search(params)
+      ResourceList.new(
+        url_base: 'events/search',
+        object_class: self,
+        key: 'events',
+        query: params
+      )
+    end
+
+    def list!
+      unless listed
+        assign_attributes('listed' => true)
+        save
+      end
+    end
+
+    def unlist!
+      if listed
+        assign_attributes('listed' => false)
+        save
+      end
+    end
+  end
+end