actv 1.1.0

data/lib/actv/configurable.rb

@@ -0,0 +1,39 @@
+module ACTV
+  module Configurable
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+      self
+    end
+
+    CONFIG_KEYS = [
+      :connection_options,
+      :endpoint,
+      :media_endpoint,
+      :middleware,
+      :search_endpoint,
+      :api_key
+    ] unless defined? CONFIG_KEYS
+
+    attr_accessor *CONFIG_KEYS
+
+    AUTH_KEYS = [
+      :consumer_key,
+      :consumer_secret,
+      :oauth_token,
+      :oauth_token_secret,
+    ] unless defined? AUTH_KEYS
+
+    attr_writer *AUTH_KEYS
+
+    class << self
+
+      def keys
+        @keys ||= CONFIG_KEYS + AUTH_KEYS
+      end
+
+    end
+
+  end
+end

data/lib/actv/default.rb

@@ -0,0 +1,87 @@
+require 'faraday'
+require 'actv/configurable'
+require 'actv/request/multipart_with_file'
+require 'actv/response/parse_json'
+require 'actv/response/raise_client_error'
+require 'actv/response/raise_server_error'
+# require 'twitter/response/rate_limit'
+require 'actv/version'
+
+module ACTV
+  module Default
+    class << self
+
+      def options
+        Hash[ACTV::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      # @note This is configurable in case you want to use HTTP instead of HTTPS or use a Active-compatible endpoint.
+      # @see http://en.blog.wordpress.com/2009/12/12/twitter-api/
+      # @see http://staff.tumblr.com/post/287703110/api
+      # @see http://developer.typepad.com/typepad-twitter-api/twitter-api.html
+      def endpoint
+        @endpoint ||= 'https://api.active.com'
+      end
+
+      def media_endpoint
+        @media_endpoint ||= 'https://upload.active.com'
+      end
+
+      def search_endpoint
+        @search_endpoint ||= 'https://search.active.com'
+      end
+
+      def connection_options
+        @connection_options ||= {
+          :headers => {
+            :accept => 'application/json',
+            :user_agent => "Active Ruby Gem #{ACTV::VERSION}"
+          },
+          :open_timeout => 5,
+          :raw => true,
+          :ssl => {:verify => false},
+          :timeout => 10,
+        }
+      end
+
+      # @note Faraday's middleware stack implementation is comparable to that of Rack middleware.  The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.
+      # @see https://github.com/technoweenie/faraday#advanced-middleware-usage
+      # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
+      def middleware
+        @middleware ||= Faraday::Builder.new(
+          &Proc.new do |builder|
+            builder.use ACTV::Request::MultipartWithFile # Convert file uploads to Faraday::UploadIO objects
+            builder.use Faraday::Request::Multipart         # Checks for files in the payload
+            builder.use Faraday::Request::UrlEncoded        # Convert request params as "www-form-urlencoded"
+            builder.use ACTV::Response::RaiseClientError # Handle 4xx server responses
+            builder.use ACTV::Response::ParseJson        # Parse JSON response bodies using MultiJson
+            builder.use ACTV::Response::RaiseServerError # Handle 5xx server responses
+            # builder.use ACTV::Response::RateLimit        # Update RateLimit object
+            builder.adapter Faraday.default_adapter         # Set Faraday's HTTP adapter
+          end
+        )
+      end
+
+      def consumer_key
+        ENV['ACTV_CONSUMER_KEY']
+      end
+
+      def consumer_secret
+        ENV['ACTV_CONSUMER_SECRET']
+      end
+
+      def oauth_token
+        ENV['ACTV_OAUTH_TOKEN']
+      end
+
+      def oauth_token_secret
+        ENV['ACTV_OAUTH_TOKEN_SECRET']
+      end
+
+      def api_key
+        nil
+      end
+
+    end
+  end
+end

data/lib/actv/error.rb

@@ -0,0 +1,32 @@
+module ACTV
+  # Custom error class for rescuing from all Twitter errors
+  class Error < StandardError
+    attr_reader :wrapped_exception
+
+    def self.errors
+      @errors ||= Hash[descendants.map{|klass| [klass.const_get(:HTTP_STATUS_CODE), klass]}]
+    end
+
+    def self.descendants
+      ObjectSpace.each_object(::Class).select{|klass| klass < self}
+    end
+
+    # Initializes a new Error object
+    #
+    # @param exception [Exception, String]
+    # @return [Twitter::Error]
+    def initialize(exception=$!)
+      if exception.respond_to?(:backtrace)
+        super(exception.message)
+        @wrapped_exception = exception
+      else
+        super(exception.to_s)
+      end
+    end
+
+    def backtrace
+      @wrapped_exception ? @wrapped_exception.backtrace : super
+    end
+
+  end
+end

data/lib/actv/error/bad_gateway.rb

@@ -0,0 +1,11 @@
+require 'actv/error/server_error'
+
+module ACTV
+  class Error
+    # Raised when Active returns the HTTP status code 502
+    class BadGateway < ACTV::Error::ServerError
+      HTTP_STATUS_CODE = 502
+      MESSAGE = "A3PI, or something it depends on (like Asset Service) is down."
+    end
+  end
+end

data/lib/actv/error/bad_request.rb

@@ -0,0 +1,10 @@
+require 'actv/error/client_error'
+
+module ACTV
+  class Error
+    # Raised when Active returns the HTTP status code 400
+    class BadRequest < ACTV::Error::ClientError
+      HTTP_STATUS_CODE = 400
+    end
+  end
+end

data/lib/actv/error/client_error.rb

@@ -0,0 +1,39 @@
+require 'actv/error'
+
+module ACTV
+  class Error
+    # Raised when Active returns a 4xx HTTP status code or there's an error in Faraday
+    class ClientError < ACTV::Error
+
+      # Create a new error from an HTTP environment
+      #
+      # @param body [Hash]
+      # @return [ACTV::Error]
+      def self.from_response_body(body)
+        new(parse_error(body))
+      end
+
+    private
+
+      def self.parse_error(body)   
+        if body.nil?
+          ''
+        elsif body[:error]
+          if body[:error].is_a? Hash
+            body[:error].fetch(:message, "")
+          else
+            body[:error]
+          end
+        elsif body[:errors]
+          first = Array(body[:errors]).first
+          if first.kind_of?(Hash)
+            first[:message].chomp
+          else
+            first.chomp
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/actv/error/enhance_your_calm.rb

@@ -0,0 +1,10 @@
+require 'actv/error/client_error'
+
+module ACTV
+  class Error
+    # Raised when Active returns the HTTP status code 420
+    class EnhanceYourCalm < ACTV::Error::ClientError
+      HTTP_STATUS_CODE = 420
+    end
+  end
+end

data/lib/actv/error/forbidden.rb

@@ -0,0 +1,10 @@
+require 'actv/error/client_error'
+
+module ACTV
+  class Error
+    # Raised when Active returns the HTTP status code 403
+    class Forbidden < ACTV::Error::ClientError
+      HTTP_STATUS_CODE = 403
+    end
+  end
+end

data/lib/actv/error/internal_server_error.rb

@@ -0,0 +1,11 @@
+require 'actv/error/server_error'
+
+module ACTV
+  class Error
+    # Raised when Active returns the HTTP status code 500
+    class InternalServerError < ACTV::Error::ServerError
+      HTTP_STATUS_CODE = 500
+      MESSAGE = "Something is technically wrong."
+    end
+  end
+end

data/lib/actv/error/not_acceptable.rb

@@ -0,0 +1,10 @@
+require 'actv/error/client_error'
+
+module ACTV
+  class Error
+    # Raised when Active returns the HTTP status code 406
+    class NotAcceptable < ACTV::Error::ClientError
+      HTTP_STATUS_CODE = 406
+    end
+  end
+end

data/lib/actv/error/not_found.rb

@@ -0,0 +1,10 @@
+require 'actv/error/client_error'
+
+module ACTV
+  class Error
+    # Raised when Active returns the HTTP status code 404
+    class NotFound < ACTV::Error::ClientError
+      HTTP_STATUS_CODE = 404
+    end
+  end
+end

data/lib/actv/error/server_error.rb

@@ -0,0 +1,19 @@
+require 'actv/error'
+
+module ACTV
+  class Error
+    # Raised when Active returns a 5xx HTTP status code
+    class ServerError < ACTV::Error
+      MESSAGE = "Server Error"
+
+      # Initializes a new ServerError object
+      #
+      # @param message [String]
+      # @return [Twitter::Error::ServerError]
+      def initialize(message=nil)
+        super(message || self.class.const_get(:MESSAGE))
+      end
+
+    end
+  end
+end

data/lib/actv/error/service_unavailable.rb

@@ -0,0 +1,11 @@
+require 'actv/error/server_error'
+
+module ACTV
+  class Error
+    # Raised when Active returns the HTTP status code 503
+    class ServiceUnavailable < ACTV::Error::ServerError
+      HTTP_STATUS_CODE = 503
+      MESSAGE = "(__-){ Active is over capacity."
+    end
+  end
+end

data/lib/actv/error/unauthorized.rb

@@ -0,0 +1,10 @@
+require 'actv/error/client_error'
+
+module ACTV
+  class Error
+    # Raised when Active returns the HTTP status code 401
+    class Unauthorized < ACTV::Error::ClientError
+      HTTP_STATUS_CODE = 401
+    end
+  end
+end

data/lib/actv/event.rb

@@ -0,0 +1,213 @@
+require 'actv/asset'
+
+module ACTV
+  class Event < ACTV::Asset
+    attr_reader :salesStartDate, :salesEndDate, :activityStartDate, :activityEndDate
+    alias sales_start_date salesStartDate
+    alias sales_end_date salesEndDate
+    alias activity_start_date activityStartDate
+    alias activity_end_date activityEndDate
+
+    def online_registration_available?
+      if is_present?(self.registrationUrlAdr)
+        if is_present?(self.legacy_data) && is_present?(self.legacy_data.onlineRegistration)
+          self.legacy_data.onlineRegistration.downcase == 'true'
+        else
+          true
+        end
+      else
+        false
+      end
+    end
+
+    def registration_open?
+      if online_registration_available?
+        is_now_between? authoritative_reg_start_date, authoritative_reg_end_date
+      else
+        false
+      end
+    end
+
+    def registration_closed?
+      if online_registration_available?
+        is_now_after? authoritative_reg_end_date
+      else
+        false
+      end
+    end
+
+    def registration_not_yet_open?
+      if online_registration_available?
+        is_now_before? authoritative_reg_start_date
+      else
+        false
+      end
+    end
+
+    def event_ended?
+      if is_present? activity_end_date
+        is_now_after? "#{activity_end_date.split('T').first}T23:59:59"
+      end
+    end
+
+    def registration_opening_soon?(time_in_days=3)
+      @reg_open_soon ||= begin
+        if online_registration_available?
+          if self.sales_start_date
+            if now_in_utc >= utc_time(self.sales_start_date) - time_in_days.days and
+              now_in_utc < utc_time(self.sales_start_date)
+              return true
+            end
+          end
+        end
+
+        false
+      end
+    end
+
+    def registration_closing_soon?(time_in_days=3)
+      @reg_closing_soon ||= begin
+        if online_registration_available?
+          if self.sales_end_date
+            if now_in_utc >= utc_time(self.sales_end_date) - time_in_days.days and
+              now_in_utc < utc_time(self.end_date)
+              return true
+            end
+          end
+        end
+
+        false
+      end
+    end
+
+    def display_close_date
+      @display_close_date ||= begin
+        val = tag_by_description 'displayclosedate'
+        if val
+          val.downcase == 'true'
+        else
+          true
+        end
+      end
+    end
+    alias display_close_date? display_close_date
+
+    ############
+
+    # Returns the asset's registration open date
+    # in UTC.  This is pulled from the salesStartDate
+    def registration_open_date
+      Time.parse "#{authoritative_reg_start_date} UTC"
+    end
+
+    # Returns the asset's registration end date
+    # in UTC.  This is pulled from the salesEndDate
+    def registration_close_date
+      Time.parse "#{authoritative_reg_end_date} UTC"
+    end
+
+    # Returns the asset's start date
+    # in UTC.  This is pulled from the activityStartDate.
+    def event_start_date
+      Time.parse "#{activity_start_date} #{format_timezone_offset(timezone_offset)}"
+    end
+
+    # Returns the asset's end date
+    # in UTC.  This is pulled from the activityEndDate.
+    def event_end_date
+      Time.parse "#{activity_end_date} #{format_timezone_offset(timezone_offset)}"
+    end
+
+    def timezone_offset
+      place.timezoneOffset + place.timezoneDST
+    end
+
+    ############
+
+    def image_url
+      defaultImage = 'http://www.active.com/images/events/hotrace.gif'
+      image = ''
+
+      self.assetImages.each do |i|
+        if i.imageUrlAdr.downcase != defaultImage
+          image = i.imageUrlAdr
+          break
+        end
+      end
+
+      if image.blank?
+        if (self.logoUrlAdr && self.logoUrlAdr != defaultImage && self.logoUrlAdr =~ URI::regexp)
+          image = self.logoUrlAdr
+        end
+      end
+      image
+    end
+
+    alias online_registration? online_registration_available?
+    alias reg_open? registration_open?
+    alias reg_closed? registration_closed?
+    alias registration_not_open? registration_not_yet_open?
+    alias reg_not_open? registration_not_yet_open?
+    alias reg_not_yet_open? registration_not_yet_open?
+    alias ended? event_ended?
+
+    private
+
+    # EG: -7 => "-0700"
+    def format_timezone_offset(offset)
+      (offset < 0 ? "-" : "") << offset.abs.to_s.rjust(2,'0') << '00'
+    end
+
+    def authoritative_reg_end_date
+      if is_present? sales_end_date
+        sales_end_date
+      elsif is_present? activity_end_date
+        "#{activity_end_date.split('T').first}T23:59:59"
+      elsif is_present? activity_start_date
+        activity_start_date
+      else
+        "2100-12-31T23:59:59"
+      end
+    end
+
+    def authoritative_reg_start_date
+      if is_present? sales_start_date
+        sales_start_date
+      else
+        "1970-01-01T00:00:00"
+      end
+    end
+
+    def is_now_before? date_string
+      now_in_utc < utc_time(date_string)
+    end
+
+    def is_now_after? date_string
+      !is_now_before? date_string
+    end
+
+    def is_now_between? start_date_string, end_date_string
+      utc_time(start_date_string) < now_in_utc && now_in_utc < utc_time(end_date_string)
+    end
+
+    def is_present? obj
+      !is_empty? obj
+    end
+
+    def is_empty? obj
+      obj.respond_to?(:empty?) ? obj.empty? : !obj
+    end
+
+    def now_in_utc
+      Time.now.utc
+    end
+
+    def utc_time(time_string)
+      return nil if time_string.nil? or time_string.empty?
+      return Time.parse(time_string).utc
+    end
+
+  end
+end
+
+