shelby-arena-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 931e155b3330e3297457065c53aaea47172a4875
+  data.tar.gz: a9dfb77ccee9f40d6dc9579988f69f20d7927fbe
+SHA512:
+  metadata.gz: bd8f6dc7dc5c054693b48b16a627466222bf571df86b1199d90449bdb5b6c96b9b4986c0fafc893650f079a0c2fcd9a33225b3ebbccde24d6fb457037e82a37e
+  data.tar.gz: c0948853eed75f02d0ed68da5ad52f5c4da3769db3a418e6e14f8302208ddccef5d05621638e346dfd570485047161feb91ba19b50f69b0cd4ab351bc1896e19

data/.gitignore

@@ -0,0 +1,10 @@
+shelby-arena-api-*.gem
+.DS_Store
+storage/*
+doc/*
+bin/
+.bundle/
+.rbenv-version
+index.rb
+.idea/*
+coverage

data/.ruby-gemset

@@ -0,0 +1 @@
+shelby-arena-api

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+gem 'typhoeus', '0.6.6'
+gem 'json'
+gem 'xml-simple'
+gem 'virtus', '1.0.2'
+
+group :development, :test do
+  gem 'rspec'
+  gem 'debugger'
+  gem 'factory_girl'
+
+  gem 'vcr'
+  gem 'webmock', '1.9' # Currently does not work with Typhoeus 0.4.2 - THIS SUCKS!
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.16)
+    axiom-types (0.1.0)
+      descendants_tracker (~> 0.0.3)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.1.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    columnize (0.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    debugger (1.6.6)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.2)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.2)
+    descendants_tracker (0.0.3)
+    diff-lcs (1.2.5)
+    equalizer (0.0.9)
+    ethon (0.6.3)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    ffi (1.9.3)
+    i18n (0.6.9)
+    ice_nine (0.11.0)
+    json (1.8.1)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    multi_json (1.9.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    safe_yaml (1.0.1)
+    thread_safe (0.1.3)
+      atomic
+    typhoeus (0.6.6)
+      ethon (~> 0.6.1)
+    tzinfo (0.3.39)
+    vcr (2.8.0)
+    virtus (1.0.2)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0.3)
+      equalizer (~> 0.0.9)
+    webmock (1.9.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    xml-simple (1.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  factory_girl
+  json
+  rspec
+  typhoeus (= 0.6.6)
+  vcr
+  virtus (= 1.0.2)
+  webmock (= 1.9)
+  xml-simple

data/README.rdoc

@@ -0,0 +1,42 @@
+= Shelby Arena API
+
+This Ruby project is an API wrapper for the Shelby Arena API
+
+
+== Install / Setup
+
+Installing the gem
+
+    gem install shelby-arena-api
+
+
+To add it to your Gemfile
+
+    gem 'shelby-arena-api', require: 'shelby_arena'
+
+
+== Example usage
+
+Checkout the examples folder.
+
+
+== Additional resources
+
+Checkout the docs folder for the PDF.
+
+
+== License
+
+This project is released under the MIT license (see LICENSE).
+
+This project is maintained by Wes Hays (https://github.com/weshays).
+
+
+== Contributors
+
+Wanna help?  It could be you...
+
+
+== Want to Contribute?
+
+If you would like to get involved in this project, then please fork the project. Make changes, add features, write some tests, and then send a pull request. 

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rspec/core/rake_task'
+
+
+desc 'Default: run specs.'
+task :default => :spec
+task :test => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+
+
+
+namespace :docs do
+
+  desc 'Build the docs for the FellowshipOne API.'
+  task :build do
+    system('rm -rf doc')
+    system('yardoc --no-private --protected lib/**/*.rb')
+  end
+
+end

data/lib/api/address.rb

@@ -0,0 +1,28 @@
+module ShelbyArena
+
+  # This is a helper class for the person object so the data coming 
+  # through via Virtus is a hash that has been converted to an array.
+  class Address < ApiObject
+    attribute :address_id, Integer
+    attribute :city, String
+    attribute :country, String
+    attribute :latitude, String
+    attribute :longitude, String
+    attribute :postal_code, String
+    attribute :primary, Boolean
+    attribute :state, String
+    attribute :street_line_1, String
+
+
+    # Constructor.
+    #
+    # @param data A hash of data
+    def initialize(data)   
+      # data[0] is 'Address'
+      # data[1] is a Hash of address info to match the attributes above.
+      initialize_from_json_object(data[1])       
+    end
+
+  end
+
+end

data/lib/api/api_object.rb

@@ -0,0 +1,32 @@
+require 'virtus'
+
+module ShelbyArena
+
+  # This class is the base class for all ShelbyArena objects and is meant to be inherited.
+  class ApiObject 
+    include Virtus.model
+
+    attr_reader :error_messages, :marked_for_destruction
+
+    # Initializes the current object from the JSON data that was loaded into the Hash
+    #
+    # @param object_attributes A Hash of values to load into the current object.
+    def initialize_from_json_object(object_attributes)
+      if object_attributes.is_a?( Hash )
+        object_attributes.each do |key, value| 
+          method_to_call = "#{ShelbyArena::attr_underscore(key)}="
+          
+          if respond_to?(method_to_call)
+            self.send(method_to_call, value) 
+          else
+            # debugger
+            # asdf=234
+            # puts "Missing :=> ".red + method_to_call.to_s  # Show the missing methods
+          end
+        end
+      end     
+    end
+
+  end
+
+end

data/lib/api/contribution.rb

@@ -0,0 +1,42 @@
+module ShelbyArena
+
+  class Contribution < ApiObject
+    attribute :contribution_id, Integer
+    attribute :transaction_number, Integer
+    attribute :currency_amount, Float
+    attribute :contribution_date, Date
+    attribute :contribution_funds, Hash
+    attribute :currency_type_id, Integer
+    attribute :currency_type_value, String
+    attribute :person_id, Integer
+    attribute :person_information, Hash
+    attribute :person_link, String
+    attribute :batch_id, Integer
+    attribute :batch_link, String
+    attribute :refund_contribution_id, Integer
+
+
+    # Load the contribution by the specified ID.
+    #
+    # @param contribution_id The ID of the contribution to load.
+    #
+    # Returns a new Contribution object.
+    def self.load_by_id(contribution_id)
+      reader = ContributionReader.new(contribution_id)
+      self.new(reader)
+    end
+
+    # Constructor.
+    #
+    # @param reader (optional) The object that has the data. This can be a ContributionReader or Hash object.
+    def initialize(reader = nil)    
+      if reader.is_a?(ContributionReader)    
+        initialize_from_json_object(reader.load_data['Contribution'])
+      elsif reader.is_a?(Hash)   
+        initialize_from_json_object(reader)
+      end
+    end
+
+  end
+
+end

data/lib/api/contribution_list.rb

@@ -0,0 +1,49 @@
+module ShelbyArena
+
+  class ContributionList
+
+    include Enumerable
+
+    # attr_reader :count, :page_number, :total_records, :additional_pages
+
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    #
+    # Options:
+    # :reader - (optional) The Reader to use to load the data.
+    def initialize(options = {})
+      reader = options[:reader] || ShelbyArena::ContributionListReader.new(options)    
+      @json_data = reader.load_data['ContributionListResult']['Contributions']['Contribution']
+    end
+
+    # Get the specified contribution.
+    #
+    # @param index The index of the contribution to get.
+    #
+    # @return Contribution
+    def [](index)
+      Contribution.new( @json_data[index] ) unless @json_data[index].nil?
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data.each{ |contribution| yield( Contribution.new(contribution) )}
+    end
+
+    # Alias the count method
+    alias :size :count
+
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      self.count == 0 ? true : false
+    end
+
+  end
+  
+end

data/lib/api/family.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/person.rb'
+
+module ShelbyArena
+
+  class Family < ApiObject
+    attribute :family_id, Integer
+    attribute :family_name, String
+    attribute :family_members, Array
+
+    # Loads the family by the specified ID.
+    #
+    # @param family The ID of the family to load.
+    #
+    # Returns a new Family object.
+    def self.load_by_id(family_id)
+      reader = FamilyReader.new(family_id)
+      self.new(reader)
+    rescue
+      nil      
+    end
+
+
+    # Constructor.
+    #
+    # @param reader (optional) The object that has the data.  This can be a PersonReader or Hash object.
+    # @param options (optional) Options for including more information.
+    def initialize(reader = nil, options = {})  
+      #@writer_object = FamilyWriter
+      if reader.is_a?(FamilyReader)
+        initialize_from_json_object(reader.load_data['Family'])        
+      elsif reader.is_a?(Hash)        
+        initialize_from_json_object(reader)
+      else # new empty
+        raise 'Not sure about this one yet'
+        # reader = FamilyReader.new
+        # initialize_from_json_object(reader.load_new['family'])
+      end      
+
+      # The data loaded from family_members is useless.  It is best to just reload all the family 
+      # members as person objects so all attributes are set.     
+      # fm[0] is 'Person'
+      # fm[1] is a Hash of person info to match some, not all, of the attributes above.
+      method_to_call = "#{ShelbyArena::attr_underscore('family_members')}="
+      self.send(method_to_call, self.family_members.collect { |fm| ShelbyArena::Person.load_by_id(fm[1]['PersonID']) })       
+    end
+
+  end
+
+end

data/lib/api/fund.rb

@@ -0,0 +1,37 @@
+module ShelbyArena
+
+  class Fund < ApiObject
+    attribute :fund_id, Integer
+    attribute :fund_name, String
+    attribute :online_name, String
+    attribute :start_date, Date
+    attribute :end_date, Date
+    attribute :active, Boolean
+    attribute :can_pledge, Boolean
+    attribute :tax_deductible, Boolean
+
+
+    # Load the fund by the specified ID.
+    #
+    # @param fund_id The ID of the fund to load.
+    #
+    # Returns a new Fund object.
+    def self.load_by_id(fund_id)
+      reader = FundReader.new(fund_id)
+      self.new(reader)
+    end
+
+    # Constructor.
+    #
+    # @param reader (optional) The object that has the data. This can be a FundReader or Hash object.
+    def initialize(reader = nil)
+      if reader.is_a?(FundReader)    
+        initialize_from_json_object(reader.load_data['Fund'])
+      elsif reader.is_a?(Hash)   
+        initialize_from_json_object(reader)
+      end
+    end
+
+  end
+
+end