stbaldricks 1.5.1.pre

data/lib/stbaldricks/enums/top_level_category_type.rb

@@ -0,0 +1,25 @@
+module SBF
+  module Client
+    module TopLevelCategoryType
+      FUNDRAISING_TOOLBOX = 'Fundraising Toolbox'
+      VEO_AND_CORE_COMMITTEE = 'VEO & Core Committee'
+      PROMOTE_YOUR_EVENT = 'Promote Your Event'
+      DAY_OF_EVENT = 'Day of Event'
+      DO_WHAT_YOU_WANT = 'Do What You Want'
+      ON_DEMAND_VIDEOS = 'On-Demand Videos'
+
+      @list = {
+        FUNDRAISING_TOOLBOX => 'fundraising_toolbox',
+        VEO_AND_CORE_COMMITTEE => 'veo_and_core_committee',
+        PROMOTE_YOUR_EVENT => 'promote_your_event',
+        DAY_OF_EVENT => 'day_of_event',
+        DO_WHAT_YOU_WANT => 'do_what_you_want',
+        ON_DEMAND_VIDEOS => 'on_demand_videos'
+      }.freeze
+
+      class << self
+        attr_reader :list
+      end
+    end
+  end
+end

data/lib/stbaldricks/errors.rb

@@ -0,0 +1,18 @@
+module SBF
+  module Client
+    # Generic error for our client library
+    class StandardError < ::StandardError; end
+
+    # Errors that arise from misuse of the Client Library
+    class Error < SBF::Client::StandardError; end
+
+    # Errors from passing an invalid URI to the client
+    class InvalidURIError < SBF::Client::Error; end
+
+    # Error that occurs when you try to access something you didn't include in the request
+    class DataNotProvidedError < SBF::Client::StandardError; end
+
+    # Error that occurs when invalid data is passed into a cachable method
+    class CacheableInvalidDataError < SBF::Client::StandardError; end
+  end
+end

data/lib/stbaldricks/log.rb

@@ -0,0 +1,16 @@
+require 'singleton'
+require 'stbaldricks/configuration'
+
+module SBF
+  module Client
+    class LOG
+      include Singleton
+
+      REQUIRED_METHODS = [:debug, :info, :warn, :error, :fatal, :unknown, :add, :level]
+
+      def self.method_missing(sym, *args, &block)
+        SBF::Client::Configuration.logger.send(sym, *args, &block)
+      end
+    end
+  end
+end

data/lib/stbaldricks/patches/array.rb

@@ -0,0 +1,6 @@
+class Array
+  def symbolize!
+    each { |it| it.symbolize! if it.is_a?(Hash) || it.is_a?(Array) }
+    self
+  end
+end

data/lib/stbaldricks/patches/boolean.rb

@@ -0,0 +1,25 @@
+module Boolean
+  def empty?
+    false
+  end
+
+  def to_b
+    self
+  end
+end
+
+class TrueClass
+  include Boolean
+
+  def blank?
+    false
+  end
+end
+
+class FalseClass
+  include Boolean
+
+  def blank?
+    true
+  end
+end

data/lib/stbaldricks/patches/class.rb

@@ -0,0 +1,13 @@
+class Class
+  def to_class
+    self
+  end
+
+  def demodulize
+    name.demodulize
+  end
+
+  def deconstantize
+    name.deconstantize
+  end
+end

data/lib/stbaldricks/patches/float.rb

@@ -0,0 +1,9 @@
+class Float
+  def blank?
+    false
+  end
+
+  def empty?
+    false
+  end
+end

data/lib/stbaldricks/patches/hash.rb

@@ -0,0 +1,16 @@
+class Hash
+  def symbolize!
+    keys.each do |key|
+      unless key.is_a? Symbol
+        value = delete(key)
+        # rubocop:disable RescueModifier
+        self[(key.to_sym rescue key) || key] = value
+        # rubocop:enable RescueModifier
+      end
+
+      value.symbolize! if value.is_a?(Hash) || value.is_a?(Array)
+    end
+
+    self
+  end
+end

data/lib/stbaldricks/patches/integer.rb

@@ -0,0 +1,9 @@
+class Integer
+  def blank?
+    false
+  end
+
+  def empty?
+    false
+  end
+end

data/lib/stbaldricks/patches/nil.rb

@@ -0,0 +1,25 @@
+class NilClass
+  def [](_)
+    nil
+  end
+
+  def []=(_, _)
+    nil
+  end
+
+  def blank?
+    true
+  end
+
+  def empty?
+    true
+  end
+
+  def include?(_)
+    false
+  end
+
+  def to_class
+    nil
+  end
+end

data/lib/stbaldricks/patches/string.rb

@@ -0,0 +1,54 @@
+class String
+  SNAKE_CASE_REGEX = Regexp.new('(?<!^)([[:upper:]])|([[:upper:]])')
+  ID_REGEX = Regexp.new('(^|_)i_d')
+  UUID_REGEX = Regexp.new('(^|_)u_u_id')
+  URL_REGEX = Regexp.new('(^|_)u_r_l')
+  MODULE_SEPARATOR = '::'
+
+  def camel_case
+    x = split('_').map do |e|
+      case e
+      when 'id', 'uuid', 'url'
+        e.upcase
+
+      else
+        # capitalize first character (capitalize will lowercase the rest of the word)
+        e[0] = e[0].capitalize
+        e
+
+      end
+    end
+
+    x.join
+  end
+
+  def snake_case
+    gsub(SNAKE_CASE_REGEX) {
+      (Regexp.last_match[1] ? "_#{Regexp.last_match[1]}" : Regexp.last_match[2]).downcase
+    }.sub(ID_REGEX, '_id').sub(UUID_REGEX, '_uuid').sub(URL_REGEX, '_url')
+  end
+
+  def blank?
+    strip.empty?
+  end
+
+  def deconstantize
+    rpartition(MODULE_SEPARATOR).first
+  end
+
+  def demodulize
+    rpartition(MODULE_SEPARATOR).last
+  end
+
+  def to_class
+    split(MODULE_SEPARATOR).reduce(Object) { |a, e| a.const_get(e.to_sym) }
+  rescue
+    nil
+  end
+
+  def to_b
+    return false if self == 'false' || self == '0'
+    return true if self == 'true' || self == '1'
+    nil
+  end
+end

data/lib/stbaldricks/request.rb

@@ -0,0 +1,146 @@
+require 'httmultiparty'
+require 'singleton'
+require 'stbaldricks/api'
+require 'stbaldricks/api_connector'
+require 'stbaldricks/configuration'
+require 'stbaldricks/log'
+require 'uri'
+
+# Require all monkey patches
+patch_dir = File.realpath("#{File.dirname(__FILE__)}/patches/")
+Dir["#{patch_dir}/*.rb"].each { |file| require file }
+
+# Require all entities
+entity_dir = File.realpath("#{File.dirname(__FILE__)}/entities/")
+Dir["#{entity_dir}/**/*.rb"].each { |file| require file }
+
+# Require all enums
+enum_dir = File.realpath("#{File.dirname(__FILE__)}/enums/")
+Dir["#{enum_dir}/*.rb"].each { |file| require file }
+
+# Client library class for accessing the St. Baldrick's Foundation API
+module SBF
+  module Client
+    module Api
+      module Request
+        # include HTTParty
+        include HTTMultiParty
+
+        base_uri SBF::Client::Configuration.base_uri
+
+        # Makes a HTTP GET request to the specified path with specified params and authentication credentials based on the configured client class.
+        # This method isn't intended to be used by a user and is for internal use only
+        #
+        # @param path [string]
+        # @param params [Hash]
+        # @return [HTTParty::Response]
+        def self.get_request(path, params = {})
+          raise SBF::Client::InvalidURIError, "Invalid URI: #{path}" unless valid_uri?(path)
+
+          # Use a public request if the user has not logged in
+          return public_get_request(path, params) if user_token.nil?
+
+          request_log('GET', path, params) do
+            get(path, options(query: params, auth: user_token))
+          end
+        end
+
+        # Makes a HTTP POST request to the specified path with specified params and authentication credentials based on the configured client class.
+        # Raises an error if the client library isn't configured with user specific credentials.
+        # This method isn't intended to be used by a user and is for internal use only
+        #
+        # @param path [string]
+        # @param params [Hash]
+        # @return [HTTParty::Response]
+        # @raise [Error]
+        def self.post_request(path, params = {})
+          raise SBF::Client::InvalidURIError, "Invalid URI: #{path}" unless valid_uri?(path)
+          raise SBF::Client::Error, 'Not yet authenticated' if user_token.nil?
+
+          request_log('POST', path, params) do
+            post(path, options(body: params.to_json, type: :post, auth: user_token))
+          end
+        end
+
+        def self.file_post_request(path:, params: {}, file:, filename:)
+          raise SBF::Client::InvalidURIError, "Invalid URI: #{path}" unless valid_uri?(path)
+          raise SBF::Client::Error, 'Not yet authenticated' if user_token.nil?
+          raise SBF::Client::Error, 'Invalid File' unless file.is_a?(File) || file.is_a?(Tempfile)
+
+          request_log('POST', path, params) do
+            post(path, options(body: params.merge(file: file, original_filename: filename), type: :file_post, auth: user_token))
+          end
+        end
+
+        # Makes a HTTP GET request to the specified path with specified params
+        # This is used for login which is the only request which should use the public key.
+        #
+        def self.public_get_request(path, params = {})
+          raise SBF::Client::InvalidURIError, "Invalid URI: #{path}" unless valid_uri?(path)
+
+          request_log('GET', path, params) do
+            get(path, options(query: params, auth: general_token))
+          end
+        end
+
+        # Makes a HTTP POST request to the specified path with specified params
+        # This is used for login which is the only request which should use the public key.
+        #
+        def self.public_post_request(path, params = {})
+          raise SBF::Client::InvalidURIError, "Invalid URI: #{path}" unless valid_uri?(path)
+
+          request_log('POST', path, params) do
+            post(path, options(body: params.to_json, type: :post, auth: general_token))
+          end
+        end
+
+        def self.options(auth: nil, type: :get, query: nil, body: nil)
+          {}.tap do |options|
+            options.merge!(base_uri: SBF::Client::Configuration.base_uri,
+                           headers: {
+                             'Accept' => 'application/json',
+                             'X-Request-Id' => SBF::Client::Configuration.request_id
+                           },
+                           verify: verify_ssl_peer?)
+            options[:body] = body if body
+            options[:query] = query if query
+            options[:headers]['Content-Type'] = 'application/json' if type == :post
+            options[:headers]['Content-Type'] = 'multipart/form-data' if type == :file_post
+            options[:headers]['Authorization'] = "Bearer #{auth}" if auth
+          end
+        end
+
+        def self.general_token
+          SBF::Client::Configuration.general_token
+        end
+        private_class_method :general_token
+
+        def self.user_token
+          SBF::Client::Configuration.user_token
+        end
+        private_class_method :user_token
+
+        def self.request_log(type, path, params)
+          SBF::Client::LOG.debug { "SBF::Client - #{type}: #{path} | Body: #{JSON.pretty_generate(params)}" }
+          response = yield
+          SBF::Client::LOG.debug { "SBF::Client - Response: #{response}" }
+          response
+        end
+        private_class_method :request_log
+
+        def self.valid_uri?(path)
+          URI.parse(path)
+          true
+        rescue URI::InvalidURIError
+          false
+        end
+        private_class_method :valid_uri?
+
+        def self.verify_ssl_peer?
+          (ENV['VERIFY_SSL_PEER'] || true).to_b
+        end
+        private_class_method :verify_ssl_peer?
+      end
+    end
+  end
+end

data/lib/stbaldricks/version.rb

@@ -0,0 +1,5 @@
+module SBF
+  module Client
+    VERSION = '1.5.1.pre'
+  end
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: stbaldricks
+version: !ruby/object:Gem::Version
+  version: 1.5.1.pre
+platform: ruby
+authors:
+- Firespring
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.16
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.4
+description: Ruby library for accessing and integrating with the St. Baldrick's Foundation
+  API
+email: opensource@stbaldricks.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/stbaldricks.rb
+- lib/stbaldricks/api.rb
+- lib/stbaldricks/api_connector.rb
+- lib/stbaldricks/client.rb
+- lib/stbaldricks/configuration.rb
+- lib/stbaldricks/default_logger.rb
+- lib/stbaldricks/endpoints/communicate.rb
+- lib/stbaldricks/endpoints/config.rb
+- lib/stbaldricks/endpoints/contact.rb
+- lib/stbaldricks/endpoints/event.rb
+- lib/stbaldricks/endpoints/event_application.rb
+- lib/stbaldricks/endpoints/fund.rb
+- lib/stbaldricks/endpoints/kid.rb
+- lib/stbaldricks/endpoints/kid_honor.rb
+- lib/stbaldricks/endpoints/lib/entity.rb
+- lib/stbaldricks/endpoints/message.rb
+- lib/stbaldricks/endpoints/newsletter_recipient.rb
+- lib/stbaldricks/endpoints/participant.rb
+- lib/stbaldricks/endpoints/photo.rb
+- lib/stbaldricks/endpoints/recurring_gift.rb
+- lib/stbaldricks/endpoints/search.rb
+- lib/stbaldricks/endpoints/shave_schedule.rb
+- lib/stbaldricks/endpoints/user.rb
+- lib/stbaldricks/entities/batch.rb
+- lib/stbaldricks/entities/campaign.rb
+- lib/stbaldricks/entities/communicate.rb
+- lib/stbaldricks/entities/config.rb
+- lib/stbaldricks/entities/contact.rb
+- lib/stbaldricks/entities/contact_group.rb
+- lib/stbaldricks/entities/document_library.rb
+- lib/stbaldricks/entities/document_library_category.rb
+- lib/stbaldricks/entities/donation.rb
+- lib/stbaldricks/entities/donation/donor_type.rb
+- lib/stbaldricks/entities/donation/how_created.rb
+- lib/stbaldricks/entities/donation/payment_type.rb
+- lib/stbaldricks/entities/donation/promo_code.rb
+- lib/stbaldricks/entities/donation/recipient_type.rb
+- lib/stbaldricks/entities/donation/special_donation_type.rb
+- lib/stbaldricks/entities/donation/status.rb
+- lib/stbaldricks/entities/donation/submitter_type.rb
+- lib/stbaldricks/entities/donor.rb
+- lib/stbaldricks/entities/event.rb
+- lib/stbaldricks/entities/event/fund_relationship_type.rb
+- lib/stbaldricks/entities/event/how_created.rb
+- lib/stbaldricks/entities/event/promo_code.rb
+- lib/stbaldricks/entities/event/status.rb
+- lib/stbaldricks/entities/event/sub_type.rb
+- lib/stbaldricks/entities/event/type.rb
+- lib/stbaldricks/entities/event_application.rb
+- lib/stbaldricks/entities/event_application/model_type.rb
+- lib/stbaldricks/entities/event_application/status.rb
+- lib/stbaldricks/entities/event_donation_summary.rb
+- lib/stbaldricks/entities/event_participant_summary.rb
+- lib/stbaldricks/entities/event_supporter.rb
+- lib/stbaldricks/entities/fund.rb
+- lib/stbaldricks/entities/fundraiser.rb
+- lib/stbaldricks/entities/international_partner.rb
+- lib/stbaldricks/entities/kid.rb
+- lib/stbaldricks/entities/kid_honor.rb
+- lib/stbaldricks/entities/lib/address.rb
+- lib/stbaldricks/entities/lib/base.rb
+- lib/stbaldricks/entities/lib/cacheable.rb
+- lib/stbaldricks/entities/lib/default_cacheable.rb
+- lib/stbaldricks/entities/lib/email_address.rb
+- lib/stbaldricks/entities/lib/error.rb
+- lib/stbaldricks/entities/lib/fundraising_page.rb
+- lib/stbaldricks/entities/lib/geo_location.rb
+- lib/stbaldricks/entities/lib/location.rb
+- lib/stbaldricks/entities/lib/name.rb
+- lib/stbaldricks/entities/lib/not_implemented_object.rb
+- lib/stbaldricks/entities/lib/opt_out_settings.rb
+- lib/stbaldricks/entities/lib/payment.rb
+- lib/stbaldricks/entities/lib/permissions.rb
+- lib/stbaldricks/entities/lib/phone.rb
+- lib/stbaldricks/entities/lib/third_party_media.rb
+- lib/stbaldricks/entities/lib/top_level.rb
+- lib/stbaldricks/entities/lib/venue.rb
+- lib/stbaldricks/entities/memorial.rb
+- lib/stbaldricks/entities/message.rb
+- lib/stbaldricks/entities/newsletter_recipient.rb
+- lib/stbaldricks/entities/organization.rb
+- lib/stbaldricks/entities/page.rb
+- lib/stbaldricks/entities/participant.rb
+- lib/stbaldricks/entities/person.rb
+- lib/stbaldricks/entities/photo.rb
+- lib/stbaldricks/entities/recurring_gift.rb
+- lib/stbaldricks/entities/response.rb
+- lib/stbaldricks/entities/search.rb
+- lib/stbaldricks/entities/section.rb
+- lib/stbaldricks/entities/shave_schedule.rb
+- lib/stbaldricks/entities/summary.rb
+- lib/stbaldricks/entities/team.rb
+- lib/stbaldricks/entities/user.rb
+- lib/stbaldricks/enums/country.rb
+- lib/stbaldricks/enums/feature.rb
+- lib/stbaldricks/enums/league_status.rb
+- lib/stbaldricks/enums/model_type.rb
+- lib/stbaldricks/enums/permission.rb
+- lib/stbaldricks/enums/permission_model_type.rb
+- lib/stbaldricks/enums/province.rb
+- lib/stbaldricks/enums/state.rb
+- lib/stbaldricks/enums/top_level_category_type.rb
+- lib/stbaldricks/errors.rb
+- lib/stbaldricks/log.rb
+- lib/stbaldricks/patches/array.rb
+- lib/stbaldricks/patches/boolean.rb
+- lib/stbaldricks/patches/class.rb
+- lib/stbaldricks/patches/float.rb
+- lib/stbaldricks/patches/hash.rb
+- lib/stbaldricks/patches/integer.rb
+- lib/stbaldricks/patches/nil.rb
+- lib/stbaldricks/patches/string.rb
+- lib/stbaldricks/request.rb
+- lib/stbaldricks/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: St. Baldrick's Foundation Ruby Client Library
+test_files: []