eventbrite_sdk 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1bdc8c292e5a97ac5b20031869bdbb311e9e257
-  data.tar.gz: 536b3b8887f554d78300dfe1b8fd1bc486b478f0
+  metadata.gz: a6c4ed26197ecfa0bb499f4c5f35669dcfeb8559
+  data.tar.gz: 101b6680b4e1d1d3c4be36cb49117def4e71ac5e
 SHA512:
-  metadata.gz: d86841a8009ac234f84f6511ed33e384668b386bb24f22308bb4b7390b8095b0c0ec1b8a35746f6338471e9bedd9787fca43fc607efd93f9d44ba954ee8dba5d
-  data.tar.gz: 658111dafb417f99bd5212f8efa87e9043ee2e5a674f00199646afc52a1dd3b70defb524bfb8d69c857d7489d5c78fbcdcf3b4a66b63ded2b23dc44e7803b553
+  metadata.gz: e2987dfccde3bbb93dcac5d4222eed4c8fb65354b0463a98c5d6d32f3d4652c3c4cffe60ec2b1a216647144545b206c74bb10258ba1f576f32cdbe1dbeedc16d
+  data.tar.gz: d1f4cf26821103f143e91fede4e3b3854132c38cac55470d69e0b081937a82bcaac3c03eb357e0da07de3846310f7839b7cf22436c31866f0900aa20bf2e165d

data/.gitignore

@@ -1,2 +1,4 @@
 Gemfile.lock
-coverage/
+.byebug_history
+coverage/
+tmp/

data/lib/eventbrite_sdk.rb

@@ -14,6 +14,8 @@ require 'eventbrite_sdk/resource/null_schema_definition'
 require 'eventbrite_sdk/resource/schema_definition'
 require 'eventbrite_sdk/blank_resource_list'
 require 'eventbrite_sdk/resource'
+require 'eventbrite_sdk/resource/field'
+require 'eventbrite_sdk/resource/field_comparable'
 require 'eventbrite_sdk/resource_list'
 
 require 'eventbrite_sdk/lists/owned_event_orders_list'
@@ -36,23 +38,23 @@ module EventbriteSDK
   EXCEPTION_MAP = {
     RestClient::ResourceNotFound => {
       class: ResourceNotFound,
-      message: 'requested object was not found',
+      message: 'requested object was not found'
     },
     RestClient::BadRequest => {
       class: BadRequest,
-      message: 'invalid request',
+      message: 'invalid request'
     },
     RestClient::Forbidden => {
       class: Forbidden,
-      message: 'not authorized',
+      message: 'not authorized'
     },
     RestClient::InternalServerError => {
       class: InternalServerError,
-      message: 'internal server error',
+      message: 'internal server error'
     },
     RestClient::Unauthorized => {
       class: Unauthorized,
-      message: 'unauthorized request',
+      message: 'unauthorized request'
     }
   }.freeze
   THREAD_EB_API_TOKEN_KEY = :eb_api_token
@@ -101,9 +103,7 @@ module EventbriteSDK
     #
     # 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
+    params[:payload] = params[:payload].to_json if params[:payload]
 
     request(params)
   end

data/lib/eventbrite_sdk/attendee.rb

@@ -18,8 +18,8 @@ module EventbriteSDK
       integer 'quantity'
       string 'profile'
       string 'costs'
-      datetime 'created', read_only: true
-      datetime 'changed', read_only: true
+      utc 'created', read_only: true
+      utc 'changed', read_only: true
       string 'resource_uri', read_only: true
     end
   end

data/lib/eventbrite_sdk/blank_resource_list.rb

@@ -34,5 +34,14 @@ module EventbriteSDK
     def to_json(opts = {})
       { @key => [] }.to_json(opts)
     end
+
+    # Blank lists need to respond to the pagination helpers.
+    def object_count
+      0
+    end
+
+    %i(page_count page_number page_size).each do |name|
+      define_method(name) { 1 }
+    end
   end
 end

data/lib/eventbrite_sdk/event.rb

@@ -21,13 +21,11 @@ module EventbriteSDK
     has_many :ticket_classes, object_class: 'TicketClass'
 
     schema_definition do
-      string 'name.html'
-      string 'description.html'
+      multipart 'name'
+      multipart 'description'
       string 'organizer_id'
-      datetime 'start.utc'
-      datetime 'start.timezone'
-      datetime 'end.utc'
-      datetime 'end.timezone'
+      datetime 'start'
+      datetime 'end'
       boolean 'hide_start_date'
       boolean 'hide_end_date'
       string 'currency'
@@ -45,8 +43,8 @@ module EventbriteSDK
       boolean 'show_remaining'
       string 'source'
       string 'status', read_only: true
-      string 'created', read_only: true
-      string 'changed', read_only: true
+      utc 'created', read_only: true
+      utc 'changed', read_only: true
       string 'resource_uri', read_only: true
     end
 

data/lib/eventbrite_sdk/media.rb

@@ -1,7 +1,6 @@
 module EventbriteSDK
   # This module implements media upload to Eventbrite based on:
   # https://docs.evbhome.com/apidocs/reference/uploads/?highlight=logo
-
   class Media < Resource
     resource_path 'media/:id'
 
@@ -11,7 +10,7 @@ module EventbriteSDK
       event_logo: 'image-event-logo',
       organizer_logo: 'image-organizer-logo',
       user_photo: 'image-user-photo',
-      event_view_from_seat: 'image-event-view-from-seat',
+      event_view_from_seat: 'image-event-view-from-seat'
     }.freeze
 
     schema_definition do
@@ -46,9 +45,7 @@ module EventbriteSDK
       type = VALID_TYPES[image_type]
 
       unless type
-        raise ArgumentError.new(
-          "image_type needs to be one of #{VALID_TYPES.keys}"
-        )
+        raise ArgumentError, "image_type needs to be one of #{VALID_TYPES.keys}"
       end
 
       request.get(url: path('upload'), query: { type: type })
@@ -58,7 +55,7 @@ module EventbriteSDK
       RestClient.post(
         instructions['upload_url'],
         instructions['upload_data'].merge(file: file),
-        multipart: true,
+        multipart: true
       )
     end
 

data/lib/eventbrite_sdk/order.rb

@@ -6,7 +6,7 @@ module EventbriteSDK
     #
     # 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 }
+    define_api_actions :resend_confirmation_email, refund: :refunds
 
     has_many :attendees, object_class: 'Attendee'
     belongs_to :event, object_class: 'Event'
@@ -17,8 +17,8 @@ module EventbriteSDK
       string 'last_name'
       string 'email'
       string 'costs'
-      datetime 'created', read_only: true
-      datetime 'changed', read_only: true
+      utc 'created', read_only: true
+      utc 'changed', read_only: true
       string 'resource_uri', read_only: true
     end
   end

data/lib/eventbrite_sdk/organizer.rb

@@ -8,8 +8,8 @@ module EventbriteSDK
 
     schema_definition do
       string 'name'
-      string 'description.html'
-      string 'long_description.html'
+      multipart 'description'
+      multipart 'long_description'
       string 'logo.id'
       string 'website'
       string 'twitter'

data/lib/eventbrite_sdk/report.rb

@@ -1,15 +1,14 @@
 module EventbriteSDK
   class Report
-    STRING_KEYS = %i(
+    STRING_KEYS = %i[
       start_date
       end_date
       date_facet
       event_status
       timezone
       group_by
-    ).freeze
-
-    VALID_REPORTS = %i(attendees sales).freeze
+    ].freeze
+    VALID_REPORTS = %i[attendees sales].freeze
 
     def initialize
       @query = {}

data/lib/eventbrite_sdk/resource.rb

@@ -27,7 +27,7 @@ module EventbriteSDK
     #   !new? && EventbriteSDK.post(url: path('unpublish'))
     # end
     def self.define_api_actions(*actions)
-      req = ->(inst, postfix) do
+      req = lambda do |inst, postfix|
         inst.instance_eval { !new? && EventbriteSDK.post(url: path(postfix)) }
       end
 
@@ -51,10 +51,10 @@ module EventbriteSDK
     end
 
     def refresh!(request: EventbriteSDK, api_token: nil)
-      unless new?
-        reload request.get(url: path, api_token: api_token)
-      else
+      if new?
         false
+      else
+        reload request.get(url: path, api_token: api_token)
       end
     end
 
@@ -63,15 +63,15 @@ module EventbriteSDK
     end
 
     def save(postfixed_path = '', api_token: nil, request: EventbriteSDK)
-      if changed? || !postfixed_path.empty?
-        response = request.post(url: path(postfixed_path),
-                                payload: attrs.payload(self.class.prefix),
-                                api_token: api_token)
+      return unless changed? || !postfixed_path.empty?
 
-        reload(response)
+      response = request.post(url: path(postfixed_path),
+                              payload: attrs.payload(self.class.prefix),
+                              api_token: api_token)
 
-        true
-      end
+      reload(response)
+
+      true
     end
 
     def to_json(opts = {})

data/lib/eventbrite_sdk/resource/attributes.rb

@@ -1,11 +1,6 @@
 module EventbriteSDK
   class Resource
     class Attributes
-      SISTER_FIELDS = {
-        'timezone' => 'utc',
-        'utc' => 'timezone'
-      }.freeze
-
       attr_reader :attrs, :changes
 
       def self.build(attrs, schema)
@@ -15,14 +10,13 @@ module EventbriteSDK
       end
 
       def initialize(hydrated_attrs = {}, schema = NullSchemaDefinition.new)
-        @attrs = {}
         @changes = {}
         @schema = schema
 
         # Build out initial hash based on schema's defined keys
-        schema.defined_keys.each { |key| bury_attribute(key, nil) }
-
-        @attrs = attrs.merge(stringify_keys(hydrated_attrs))
+        @attrs = schema.defined_keys.each_with_object({}) do |key, attrs|
+          Field.new(key, nil).bury(attrs)
+        end.merge(stringify_keys(hydrated_attrs))
       end
 
       def [](key)
@@ -31,7 +25,8 @@ module EventbriteSDK
 
       def assign_attributes(new_attrs)
         stringify_keys(new_attrs).each do |attribute_key, value|
-          assign_value(attribute_key, value) if schema.writeable?(attribute_key)
+          value = Field.new(attribute_key, value, schema: schema)
+          changes.merge! value.apply(attrs, changes)
         end
 
         nil
@@ -55,7 +50,7 @@ module EventbriteSDK
 
       def reset!
         changes.each do |attribute_key, (old_value, _current_value)|
-          bury_attribute(attribute_key, old_value)
+          Field.new(attribute_key, old_value).bury(attrs)
         end
 
         @changes = {}
@@ -68,18 +63,12 @@ module EventbriteSDK
       # prefix: This is needed due to inconsistencies in the EB API
       #         Sometimes there's a prefix, sometimes there's not,
       #         sometimes it's singular, sometimes it's plural.
-      #         Once the API gets a bit more nomalized we can remove this
-      #         alltogether and infer a prefix based
+      #         Once the API gets a bit more normalized we can remove this
+      #         altogether and infer a prefix based
       #         on the class name of the resource
       def payload(prefix = nil)
         changes.each_with_object({}) do |(attribute_key, (_, value)), payload|
-          key = if prefix
-                  "#{prefix}.#{attribute_key}"
-                else
-                  attribute_key
-                end
-
-          bury(key, value, payload)
+          Field.new(attribute_key, value, prefix: prefix).bury(payload)
         end
       end
 
@@ -91,52 +80,10 @@ module EventbriteSDK
 
       attr_reader :schema
 
-      def assign_value(attribute_key, value)
-        dirty_check(attribute_key, value)
-        add_rich_value(attribute_key)
-        bury_attribute(attribute_key, value)
-      end
-
-      def dirty_check(attribute_key, value)
-        initial_value = attrs.dig(*attribute_key.split('.'))
-
-        if initial_value != value
-          changes[attribute_key] = [initial_value, value]
-        end
-      end
-
-      def bury_attribute(attribute_key, value)
-        bury(attribute_key, value, attrs)
-      end
-
-      # Since we use dirty checking to determine what the payload is
-      # you can run into a case where a "rich media" field needs other attrs
-      # Namely timezone, so if a rich date changed, add the tz with it.
-      def add_rich_value(attribute_key)
-        if changes[attribute_key] && attribute_key =~ /\A(.+)\.(utc|timezone)\z/
-          field = Regexp.last_match(2)
-          key_prefix = Regexp.last_match(1)
-
-          handle_sister_field(key_prefix, field)
-        end
-      end
-
-      def bury(attribute_key, value, hash = {})
-        keys = attribute_key.split '.'
-
-        # Hand rolling #bury
-        # hopefully we get it in the next release of Ruby
-        keys.each_cons(2).reduce(hash) do |prev_attrs, (key, _)|
-          prev_attrs[key] ||= {}
-        end[keys.last] = value
-
-        hash
-      end
-
       def method_missing(method_name, *_args, &_block)
         requested_key = method_name.to_s
 
-        if attrs.has_key?(requested_key)
+        if attrs.key?(requested_key)
           handle_requested_attr(attrs[requested_key])
         else
           super
@@ -144,16 +91,7 @@ module EventbriteSDK
       end
 
       def respond_to_missing?(method_name, _include_private = false)
-        attrs.has_key?(method_name.to_s) || super
-      end
-
-      def handle_sister_field(key_prefix, field)
-        sister_field = SISTER_FIELDS[field]
-        stale_value = attrs.dig(key_prefix, sister_field)
-
-        unless changes["#{key_prefix}.#{sister_field}"]
-          changes["#{key_prefix}.#{sister_field}"] = [stale_value, stale_value]
-        end
+        attrs.key?(method_name.to_s) || super
       end
 
       def handle_requested_attr(value)

data/lib/eventbrite_sdk/resource/field.rb

@@ -0,0 +1,90 @@
+module EventbriteSDK
+  class Resource
+    class Field
+      SIBLING_KEYMAP = { 'timezone' => 'utc', 'utc' => 'timezone' }.freeze
+      SIBLING_REGEX = /\A(.+)\.(utc|timezone)\z/
+
+      attr_reader :key, :value, :initial_value
+
+      def initialize(key, value, prefix: nil, schema: NullSchemaDefinition.new)
+        @key = (prefix && "#{prefix}.#{key}") || key
+        @schema = schema
+        @value = value
+        @datetime = false
+      end
+
+      def changes(attrs, changes)
+        %i[basic_changes rich_changes].reduce({}) do |diff, method|
+          diff.merge send(method, attrs, changes)
+        end
+      end
+
+      def keys
+        key.split('.')
+      end
+
+      def writeable?
+        schema.writeable?(key)
+      end
+
+      def apply(attrs, existing_changes)
+        if writeable?
+          changes(attrs, existing_changes).tap { bury(attrs) }
+        else
+          {}
+        end
+      end
+
+      def bury(hash = {})
+        nested_keys = keys
+        # Hand rolling #bury, hopefully we get it in the next release of Ruby.
+        # UPDATE: we won't https://bugs.ruby-lang.org/issues/11747
+        nested_keys.each_cons(2).reduce(hash) do |prev_attrs, (nkey, _)|
+          prev_attrs[nkey] ||= {}
+        end[nested_keys.last] = value
+
+        hash
+      end
+
+      private
+
+      attr_reader :datetime, :schema
+
+      def basic_changes(attrs, _changes)
+        @initial_value = attrs.dig(*keys)
+        comp_value = schema.dirty_comparable(self)
+
+        (comp_value != value && { key => [initial_value, value] }) || {}
+      end
+
+      def rich_changes(attrs, changes)
+        if key =~ SIBLING_REGEX && !changes[sister_field]
+          @datetime = true
+          { sister_field => sister_change(attrs) }
+        else
+          {}
+        end
+      end
+
+      def sister
+        if key =~ SIBLING_REGEX
+          key_prefix = Regexp.last_match(1)
+          sister_field = SIBLING_KEYMAP[Regexp.last_match(2)]
+
+          [key_prefix, sister_field]
+        end
+      end
+
+      def sister_field
+        sister.join('.')
+      end
+
+      # Since we use dirty checking to determine what the payload is
+      # you can run into a case where a "rich media" field needs other attrs
+      # Namely timezone, so if a rich date changed, add the tz with it.
+      def sister_change(attrs)
+        Array.new(2) { attrs.dig(*sister) }
+      end
+    end
+  end
+end

data/lib/eventbrite_sdk/resource/field_comparable.rb

@@ -0,0 +1,13 @@
+module EventbriteSDK
+  class Resource
+    class FieldComparable
+      def value_for(type, field)
+        if type == :currency && field.initial_value
+          field.initial_value.values_at(:currency, :value).join(',')
+        else
+          field.initial_value
+        end
+      end
+    end
+  end
+end

data/lib/eventbrite_sdk/resource/null_schema_definition.rb

@@ -8,6 +8,10 @@ module EventbriteSDK
       def defined_keys
         []
       end
+
+      def dirty_comparable(field)
+        field.initial_value
+      end
     end
   end
 end

data/lib/eventbrite_sdk/resource/schema_definition.rb

@@ -1,18 +1,26 @@
+require 'byebug'
 module EventbriteSDK
   class Resource
     class SchemaDefinition
       def initialize(resource_name)
-        @resource_name = resource_name
-        @read_only_keys = Set.new
         @attrs = {}
+        @read_only_keys = Set.new
+        @comparable = FieldComparable.new
+        @resource_name = resource_name
       end
 
-      %i(boolean currency datetime integer string).each do |method|
+      %i[
+        boolean
+        currency
+        datetime
+        integer
+        multipart
+        string
+        utc
+      ].each do |method|
         define_method(method) do |value, *opts|
-          options = opts.first
-
-          @read_only_keys << value if options && options[:read_only]
-          @attrs[value] = method
+          add_field_options(opts, value, method)
+          add_field(opts, value, method)
         end
       end
 
@@ -28,9 +36,44 @@ module EventbriteSDK
         attrs.keys
       end
 
+      def dirty_comparable(field)
+        comparable.value_for(attrs[field.key], field)
+      end
+
       private
 
-      attr_reader :read_only_keys, :resource_name, :attrs
+      attr_reader :comparable ,:read_only_keys, :resource_name, :attrs
+
+      def add_field_options(opts, value, _method)
+        options = opts.first
+        @read_only_keys << value if options && options[:read_only]
+      end
+
+      def add_field(_options, value, method)
+        @attrs[value] = method
+        send(:"#{method}_expansion", value)
+      end
+
+      # The following fields are NO-OP expansions
+      %i[boolean integer multipart string utc].each do |type|
+        define_method("#{type}_expansion") { |val| }
+      end
+
+      def currency_expansion(value)
+        generic_expansion(%w[currency display value], value)
+      end
+
+      def datetime_expansion(value)
+        generic_expansion(%w[local utc timezone], value)
+      end
+
+      def multipart_expansion(value)
+        generic_expansion(%i[html text], value)
+      end
+
+      def generic_expansion(types, value)
+        types.map { |exp| @attrs["#{value}.#{exp}"] = :string }
+      end
 
       def read_only?(key)
         read_only_keys.member?(key)

data/lib/eventbrite_sdk/resource_list.rb

@@ -49,7 +49,7 @@ module EventbriteSDK
       page(pagination['page_number'] - 1, api_token: api_token)
     end
 
-    %w(object_count page_number page_size page_count).each do |method|
+    %w[object_count page_number page_size page_count].each do |method|
       define_method(method) { pagination[method] }
     end
 
@@ -73,6 +73,14 @@ module EventbriteSDK
 
     private
 
+    attr_reader :expansion,
+                :key,
+                :object_class,
+                :objects,
+                :query,
+                :request,
+                :url_base
+
     def pagination
       @pagination ||= { 'page_count' => 1, 'page_number' => 1 }
     end
@@ -87,13 +95,5 @@ module EventbriteSDK
       @objects = (response[key.to_s] || []).map { |raw| object_class.new(raw) }
       @pagination = response['pagination']
     end
-
-    attr_reader :expansion,
-                :key,
-                :object_class,
-                :objects,
-                :query,
-                :request,
-                :url_base
   end
 end

data/lib/eventbrite_sdk/ticket_class.rb

@@ -26,8 +26,8 @@ module EventbriteSDK
       boolean 'include_fee'
       boolean 'split_fee'
       string 'sales_channels'
-      datetime 'sales_start'
-      datetime 'sales_end'
+      utc 'sales_start'
+      utc 'sales_end'
       string 'sales_start_after'
       integer 'minimum_quantity'
       integer 'maximum_quantity'
@@ -50,7 +50,7 @@ module EventbriteSDK
     end
 
     def unhide!
-      ! hidden || change('hidden' => false)
+      !hidden || change('hidden' => false)
     end
 
     def change(attrs)

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.1.1'.freeze
+  VERSION = '3.1.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eventbrite_sdk
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Vinnie Franco
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -129,6 +129,8 @@ files:
 - lib/eventbrite_sdk/report.rb
 - lib/eventbrite_sdk/resource.rb
 - lib/eventbrite_sdk/resource/attributes.rb
+- lib/eventbrite_sdk/resource/field.rb
+- lib/eventbrite_sdk/resource/field_comparable.rb
 - lib/eventbrite_sdk/resource/null_schema_definition.rb
 - lib/eventbrite_sdk/resource/operations/attribute_schema.rb
 - lib/eventbrite_sdk/resource/operations/endpoint.rb
@@ -162,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Official Eventbrite SDK for the v3 API