eventbrite_sdk 3.4.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c1e67123425f40c0f27d858eb440c95f5a19d2d
-  data.tar.gz: a7e48208c305d9bc8e89525c73097114bd6821f5
+  metadata.gz: 6c404806f54b4030c3f5d46eb24f032d7efa90a4
+  data.tar.gz: 5a748033c1fc2416359d5a0b988d3c0d43c32d23
 SHA512:
-  metadata.gz: c40cc4297d6aa7c915ff70c5580b4c32f2193191eaec752e69bef68d5912d9156bf3d8187ae5fcbf7cc9c5f5c1e0b592b09c939b9c7813f83cbba48db1538e25
-  data.tar.gz: 8d1b496743e38f269e3c8cd23b843ac47c185b7d825294c810ec5937ad22bb20f67fcade02a4efa4b948c31d717813ea1bb28aac6bb862104322e70aa4b38ac9
+  metadata.gz: 0274a3d9e0e3205e49edd0be92ec94b0ad3076e621f47da10376a3f637b11f891ecc64b9c9be41b43e0209125005c72802224e591e672a20f7dcff615ca06913
+  data.tar.gz: 9687f9cb26715fd0b3afb0f16ce854407ba44b82f4173ad4ed0753c249ca13315885aede36a77b483ef456713173d4fc7f714b7b250e575a706b5fe497403690

data/.gitignore

@@ -2,3 +2,4 @@ Gemfile.lock
 .byebug_history
 coverage/
 tmp/
+.ruby-version

data/README.md

@@ -2,9 +2,6 @@
 
 [![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:
@@ -69,13 +66,14 @@ your_event.save
 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 
+# 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
@@ -102,6 +100,18 @@ example.continue
 # you can also provide a token if you choose to do so
 example.continue(continuation_token: 'my_token')
 ```
+
+# Use `#retrieve` to build up arbitrary queries
+
+``` ruby
+
+# For example, to use the 'status' parameter seen here: https://www.eventbrite.com/developer/v3/endpoints/events/#ebapi-id78
+
+user = EventbriteSDK::User.retrieve(id: 163054428874)
+user.owned_events.retrieve(query: { status: 'live' })
+
+```
+
 # Construct endpoint paths:
 
 ``` ruby
@@ -130,7 +140,7 @@ order = EventbriteSDK::Order.retrieve(id: id, expand: [:attendees, :event])
 
 # Per-request Configuration
 
-For apps that need to use multiple tokens during the lifetime of a process, it is 
+For apps that need to use multiple tokens during the lifetime of a process, it is
 possible to set a per-request token:
 
 ``` ruby
@@ -161,7 +171,7 @@ will fall-back on the global token for the action called.
 
 # Shallow resource list endpoints
 
-Some paginated lists are available at the base of the resource url, webhooks and 
+Some paginated lists are available at the base of the resource url, webhooks and
 categories for example. The resources that have this trait will include the `Operations::List` module
 
 ``` ruby

data/eventbrite_sdk.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rest-client', '~> 2.0'
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '>= 2.1'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.11'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'

data/lib/eventbrite_sdk.rb

@@ -22,9 +22,11 @@ require 'eventbrite_sdk/lists/owned_event_orders_list'
 
 require 'eventbrite_sdk/attendee'
 require 'eventbrite_sdk/category'
+require 'eventbrite_sdk/discount'
 require 'eventbrite_sdk/event'
 require 'eventbrite_sdk/media'
 require 'eventbrite_sdk/order'
+require 'eventbrite_sdk/organization'
 require 'eventbrite_sdk/organizer'
 require 'eventbrite_sdk/report'
 require 'eventbrite_sdk/subcategory'
@@ -33,6 +35,7 @@ require 'eventbrite_sdk/ticket_group'
 require 'eventbrite_sdk/user'
 require 'eventbrite_sdk/venue'
 require 'eventbrite_sdk/webhook'
+require 'eventbrite_sdk/organization_entities' # depends on Discount, Event, Venue
 
 module EventbriteSDK
   BASE = "https://www.eventbriteapi.com/v#{VERSION.split('.').first}".freeze

data/lib/eventbrite_sdk/discount.rb

@@ -0,0 +1,78 @@
+module EventbriteSDK
+  class Discount < Resource
+    ACCESS_HIDDEN_TICKETS = 'access'.freeze # unlock access to hidden tickets
+    ACCESS_HOLDS = 'hold'.freeze            # unlock access to HoldClasses (reserved seating)
+    PROTECTED_DISCOUNT = 'coded'.freeze     # unlock a discount
+    PUBLIC_DISCOUNT = 'public'.freeze       # a publicly available discount
+
+    TYPES = [
+      ACCESS_HIDDEN_TICKETS,
+      ACCESS_HOLDS,
+      PROTECTED_DISCOUNT,
+      PUBLIC_DISCOUNT
+    ].freeze
+
+    resource_path 'discounts/:id'
+
+    belongs_to :event, object_class: 'Event'
+    belongs_to :ticket_group, object_class: 'TicketGroup'
+
+    attributes_prefix 'discount'
+
+    schema_definition do
+      string 'amount_off'           # Fixed reduction amount as a decimal - "12.99".
+      string 'code'                 # required: Code used to activate discount.
+      string 'discount_type'        # required: Type of discount. (Valid choices are: access, hold, coded, or public)
+      string 'end_date'             # Allow use until this date.
+      integer 'end_date_relative'   # Allow use until this number of seconds before the event starts.
+      string 'event_id'             # ID of the event. Only used for single event discounts.
+      string 'hold_ids'             # IDs of holds this discount can unlock
+      string 'percent_off'          # Percentage reduction. Supports 2 digit decimal precision - "50" or "50.01".
+      integer 'quantity_available'  # Number of discount uses.
+      string 'start_date'           # Allow use from this date.
+      integer 'start_date_relative' # Allow use from this number of seconds before the event starts.
+      string 'ticket_group_id'      # ID of the ticket group
+      string 'ticket_ids'           # IDs of tickets to limit discount to
+    end
+
+
+    def access_hidden_tickets?
+      discount_type == ACCESS_HIDDEN_TICKETS
+    end
+
+    def access_holds?
+      discount_type == ACCESS_HOLDS
+    end
+
+    def discount?
+      protected_discount? || public_discount?
+    end
+
+    def protected_discount?
+      discount_type == PROTECTED_DISCOUNT
+    end
+
+    def public_discount?
+      discount_type == PUBLIC_DISCOUNT
+    end
+
+    #
+    # Ticket groups that are auto created for all tickets of an org can NOT be
+    # accessed through the API, even though the ticket_group_id is present.
+    #
+    # We expand ticket_group on all queries - so ticket_group_id exists
+    # for that group, and ticket_group is present with a nil value in the data.
+    # In that case, when you call Discount#ticket_group the resource would
+    # attempt to retrieve it... and the API would return a 404 response. Bad.
+    #
+    # You can't use Discount#ticket_group unless it's safe to do so.
+    # You have to check the attribute data to verify that calling #ticket_group
+    # will not try to retrieve a "forbidden" group and raise an exception
+    #
+    def ticket_group_accessible?
+      !ticket_group_id.nil? &&
+        attrs.respond_to?(:ticket_group) &&
+        !attrs['ticket_group'].nil?
+    end
+  end
+end

data/lib/eventbrite_sdk/event.rb

@@ -57,15 +57,6 @@ module EventbriteSDK
       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)

data/lib/eventbrite_sdk/order.rb

@@ -2,12 +2,6 @@ module EventbriteSDK
   class Order < Resource
     resource_path 'orders/:id'
 
-    # Defines order#resend_confirmation_email and order#refund
-    #
-    # When an event has an id the POST is made, otherwise we return false
-    # POSTS to order/:id/(resend_confirmation_email|refunds)
-    define_api_actions :resend_confirmation_email, refund: :refunds
-
     has_many :attendees, object_class: 'Attendee'
     belongs_to :event, object_class: 'Event'
 

data/lib/eventbrite_sdk/organization.rb

@@ -0,0 +1,131 @@
+module EventbriteSDK
+  class Organization < Resource
+    ALL_DISCOUNTS = 'user',
+    SINGLE_EVENT_DISCOUNTS = 'event',
+    MULTI_EVENT_DISCOUNTS = 'multi_events',
+
+    # Event search "order_by" values
+    CREATED_NEWEST_FIRST = 'created_desc',
+    CREATED_OLDEST_FIRST = 'created_asc',
+    START_NEWEST_FIRST = 'start_desc',
+    START_OLDEST_FIRST = 'start_asc',
+
+    # Event search "status" values
+    # ALL will cause the search to return any of the following:
+    #   canceled
+    #   ended
+    #   finalized
+    #   incomplete
+    #   live
+    #   started
+    #   payout_issued
+    ALL = 'all',
+    CANCELED = 'canceled',
+    DRAFT = 'draft',
+    # ENDED will return any of the following:
+    #   ended
+    #   finalized
+    #   payout_issued
+    ENDED = 'ended',
+    LIVE = 'live',
+    STARTED = 'started'
+
+    # Search order values
+    SEARCH_ORDERS_STATUS_ALL = 'all_not_deleted'
+    SEARCH_ORDERS_STATUS_ACTIVE = 'active'
+    SEARCH_ORDERS_STATUS_INACTIVE = 'inactive'
+    SEARCH_ORDERS_STATUS_ACTIVE_AND_INACTIVE = 'both'
+
+    resource_path 'organizations/:id'
+
+    has_many :discounts, object_class: 'OrgDiscount'
+    has_many :organizers, object_class: 'Organizer', key: :organizers
+    # Previously :owned_event_orders
+    has_many :orders, object_class: 'Order', key: :orders
+    # Previously :owned_events
+    has_many :events, object_class: 'OrgEvent', key: :events
+    has_many :ticket_classes, object_class: 'TicketClass'
+    has_many :ticket_groups, object_class: 'TicketGroup'
+    # Query for all events, ordered by start date in ascending order.
+    #
+    #   order_by: Change the order they are returned. Supports:
+    #     created_asc
+    #     created_desc
+    #     start_asc
+    #     start_desc
+    #
+    #   status: Status(es) of events you want. Supports single values or CSV:
+    #     all      - all available statuses. Includes:
+    #     canceled - only canceled.
+    #     draft    - only draft
+    #     ended    - all ended statuses. Includes:
+    #     live     - only live
+    #     started  - only started
+    #
+    def upcoming_events(order_by: self.class::START_OLDEST_FIRST,
+                        status: self.class::ALL)
+      EventbriteSDK::ResourceList.new(
+        url_base: "#{path}/events",
+        object_class: EventbriteSDK::Event,
+        key: 'events',
+        query: {
+          order_by: order_by,
+          status: status
+        }
+      )
+    end
+
+    #
+    # Retrieve all orders for the organization based on given search criteria.
+    # changed_since  - datetime - orders changed on or after the given datetime.
+    #                  You can also pass a string formatted as %FT%TZ
+    # exclude_emails - string array - do not include orders for these emails
+    # only_emails    - string array - only include orders for these emails
+    # status         - One of: all, active, inactive, active_and_inactive
+    #
+    # This method does no parameter validation. If you pass an unsupported status
+    # or an invalid format changed_since you'll definitely hear about if from
+    # the endpoint.
+    #
+    def search_orders(params={})
+      coerce_search_orders_params(params)
+
+      EventbriteSDK::ResourceList.new(
+        url_base: "#{path}/orders",
+        object_class: EventbriteSDK::Order,
+        key: :orders,
+        query: params
+      )
+    end
+
+    # NOTE Shim to normalize API between a user/organization
+    def owned_events
+      events
+    end
+
+    private
+
+    def coerce_search_orders_params(params)
+      format_changed_since(params)
+      format_emails(params)
+
+      params
+    end
+
+    def format_changed_since(params)
+      value = params[:changed_since]
+
+      if value and value.respond_to?(:strftime)
+        params[:changed_since] = value.strftime('%FT%TZ')
+      end
+    end
+
+    def format_emails(params)
+      for key in %i(exclude_emails only_emails)
+        if params[key] and params[key].any?
+          params[key] = params[key].join(',')
+        end
+      end
+    end
+  end
+end

data/lib/eventbrite_sdk/organization_entities.rb

@@ -0,0 +1,16 @@
+class EventbriteSDK::OrgDiscount < EventbriteSDK::Discount
+  resource_path create: 'organizations/:organization_id/discounts',
+                update: 'discounts/:id'
+end
+
+class EventbriteSDK::OrgVenue < EventbriteSDK::Venue
+  resource_path create: 'organizations/:organization_id/venues',
+                update: 'venues/:id'
+end
+
+class EventbriteSDK::OrgEvent < EventbriteSDK::Event
+  resource_path create: 'organizations/:organization_id/events',
+                update: 'events/:id'
+
+  belongs_to :venue, object_class: 'OrgVenue'
+end

data/lib/eventbrite_sdk/user.rb

@@ -1,18 +1,10 @@
 module EventbriteSDK
   class User < Resource
-    # Defines user#verify and user#unverify
-    #
-    # An user logged using Eventbrite we should generate a verification action
-    # NOTE: only selected users can verify/unverify other users.
-    # POSTS to users/:id/(verify|unverify)
-    define_api_actions :verify, :unverify
-
     resource_path 'users/:id'
 
-    has_many :organizers, object_class: 'Organizer', key: :organizers
+    # NOTE: This name is pretty legacy. We should consider renaming
+    # to "orders" to normalize things.
     has_many :owned_event_orders, object_class: 'Order', key: :orders
-    has_many :owned_events, object_class: 'Event', key: :events
-    has_many :ticket_groups, object_class: 'TicketGroup'
 
     schema_definition do
       string 'name'

data/lib/eventbrite_sdk/venue.rb

@@ -4,19 +4,22 @@ module EventbriteSDK
 
     attributes_prefix 'venue'
 
-    belongs_to :organizer, object_class: 'Organizer'
-
     schema_definition do
-      string 'name'
-      string 'address.latitude'
-      string 'address.longitude'
-      string 'organizer_id'
       string 'address.address_1'
       string 'address.address_2'
       string 'address.city'
-      string 'address.region'
-      string 'address.postal_code'
       string 'address.country'
+      string 'address.latitude' # decimal, passed as string.
+      string 'address.localized_address_display'
+      string 'address.localized_area_display'
+      string 'address.longitude' # decimal, passed as string.
+      string 'address.postal_code'
+      string 'address.region'
+      string 'age_restriction'
+      string 'capacity'
+      string 'latitude'
+      string 'longitude'
+      string 'name'
     end
   end
 end

data/lib/eventbrite_sdk/version.rb

@@ -1,5 +1,5 @@
 module EventbriteSDK
   # Major should always line up with the major point release of the public API
   # v3 => 3.x.x
-  VERSION = '3.4.0'.freeze
+  VERSION = '3.6.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eventbrite_sdk
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Vinnie Franco
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,30 +30,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -121,12 +121,15 @@ files:
 - lib/eventbrite_sdk/attendee.rb
 - lib/eventbrite_sdk/blank_resource_list.rb
 - lib/eventbrite_sdk/category.rb
+- lib/eventbrite_sdk/discount.rb
 - lib/eventbrite_sdk/error_types.rb
 - lib/eventbrite_sdk/event.rb
 - lib/eventbrite_sdk/exceptions.rb
 - lib/eventbrite_sdk/lists/owned_event_orders_list.rb
 - lib/eventbrite_sdk/media.rb
 - lib/eventbrite_sdk/order.rb
+- lib/eventbrite_sdk/organization.rb
+- lib/eventbrite_sdk/organization_entities.rb
 - lib/eventbrite_sdk/organizer.rb
 - lib/eventbrite_sdk/report.rb
 - lib/eventbrite_sdk/resource.rb