shelby-arena-api 0.1.0

data/lib/readers/person_list_reader.rb

@@ -0,0 +1,45 @@
+module ShelbyArena
+
+  class PersonListReader < ApiReader
+
+    # Constructor.
+    def initialize(options = {})
+      # page = options[:page] || 1
+      # per_page = options[:per_page] || 100
+
+      @url_data_params = {}
+      valid_fields.each { |field| @url_data_params[field] = options[ShelbyArena::attr_underscore(field).to_sym] unless options[ShelbyArena::attr_underscore(field).to_sym].nil? }
+      @url_data_path = 'person/list'
+    end
+
+    def valid_fields
+      %W(Address 
+         altID 
+         areaId 
+         birthdate 
+         email 
+         giftID 
+         loginID 
+         firstName 
+         lastName 
+         personID 
+         phone 
+         profileID 
+         onlyConnected 
+         searchDistance 
+         latitude 
+         longitude 
+         campusID 
+         includeInactive 
+         memberStatus 
+         attributeID 
+         attributeIntValue 
+         attributeVarcharValue 
+         attributeDateTimeValue 
+         attributeDecimalValue 
+         name).sort
+    end
+
+  end
+
+end

data/lib/readers/person_reader.rb

@@ -0,0 +1,21 @@
+module ShelbyArena
+
+  class PersonReader < ApiReader
+
+    # Constructor.
+    #
+    # @param person_id (optional) The ID of the person to load.
+    def initialize(person_id = nil)
+      if person_id.nil?
+        raise 'The create endpoint is not known yet.'
+        @url_new_data_path = nil # Not sure yet
+      else
+        @url_data_path = "person/#{person_id}"
+      end
+    end
+    
+  end
+
+end
+
+

data/lib/shelby_arena.rb

@@ -0,0 +1,37 @@
+require 'typhoeus'
+require 'json'
+require 'xmlsimple'
+
+# The path to the lib directory.
+SHELBY_ARENA_LIB_DIR = File.dirname(__FILE__)
+
+require File.dirname(__FILE__) + '/auto_load.rb'
+
+require File.dirname(__FILE__) + '/common.rb'
+
+module ShelbyArena
+
+  class Api
+
+    class << self
+      attr_reader :username, :password, :api_key, :api_secret, :service_url, :session_key
+    end    
+
+    def self.request_session(username, password, api_key, service_url)
+      @username    = username
+      @password    = password
+      @api_key     = api_key   
+      @service_url = service_url
+      ShelbySession.new(ShelbyArena.request_session)
+    end    
+
+    def self.connect(session_key, api_secret, service_url)
+      @session_key = session_key
+      @api_secret  = api_secret   
+      @service_url = service_url
+      true
+    end
+
+  end
+
+end

data/lib/writers/api_writer.rb

@@ -0,0 +1,76 @@
+module ShelbyArena
+
+  # This class is the base class for all ShelbyArena objects and is meant to be inherited.
+  #
+  class ApiWriter 
+    attr_reader :error_messages, :response_code
+
+  end
+end
+
+
+
+# module FellowshipOne
+
+#   # This adapter is the standard for all saving objects.
+#   class ApiWriter
+#     attr_reader :error_messages, :response_code
+
+#     # Saves this object.
+#     #
+#     # @return True or ID on success, otherwise false.
+#     def save_object
+#       @url_data_params ||= {}
+#       success = true
+
+#       if @url_data_path.nil?
+#         @error_messages = ["#{@url_action.to_s.upcase} not implemented for #{self.class.to_s}"]
+#         return false
+#       end
+
+#       if @updatable_fields and !@updatable_fields.empty?
+#         # fields_to_remove = @url_data_params.keys - @updatable_fields  
+#         # fields_to_remove.each { |ftr| @url_data_params.delete(ftr) }
+#       end
+
+#       begin
+#         response = FellowshipOne::api_request(@url_action, @url_data_path, [], @url_data_params.to_json)
+#         @response_code = response.code
+#         # No content but is a success
+#         success = response.code == 204 ? {'success' => true} : JSON.parse(response.body)
+#       rescue Exception => e  
+#         @error_messages = e.message.split(',')
+#         success = false
+#       end 
+
+#       return success
+#     end
+
+
+#     # Deletes this object.
+#     #
+#     # @return True or ID on success, otherwise false.
+#     def delete_object
+#       success = true
+
+#       if @url_data_delete_path.nil?
+#         @error_messages = ["DELETE not implemented for #{self.class.to_s}"]
+#         return false
+#       end
+
+#       begin
+#         # @url_data_path should be the same as :put if this object is already
+#         # setup and mapped to an object that exists
+#         response = FellowshipOne::api_request(:delete, @url_data_delete_path)
+#         success = response.code == 204 ? true : false # No content but is a success
+#       rescue Exception => e  
+#         @error_messages = e.message.split(',')
+#         success = false
+#       end 
+
+#       return success
+#     end    
+
+#   end
+
+# end

data/lib/writers/person_writer.rb

@@ -0,0 +1,64 @@
+module ShelbyArena
+
+  class PersonWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json object data to save.
+    def initialize(data)
+      if data[:id]
+        @url_action = :put
+        @url_data_path = "/v1/People/#{data[:id]}"
+      else
+        @url_action = :post
+        @url_data_path = "/v1/People"
+      end
+      @url_data_delete_path = "/v1/People/#{data[:id]}"
+
+      @url_data_params = {'person' => data}
+
+      @updatable_fields = [:title,
+                           :salutation,
+                           :prefix,
+                           :first_name, 
+                           :last_name,  #required
+                           :suffix,
+                           :middle_name,
+                           :goes_by_name,
+                           :former_name,
+                           :gender,
+                           :date_of_birth,
+                           :marital_status,
+                           :household_member_type, #required
+                           :is_authorized,
+                           :status, #required
+                           :occupation,
+                           :employer,
+                           :school,
+                           :denomination,
+                           :former_church,
+                           :bar_code,
+                           :member_envelope_code,
+                           :default_tag_comment,
+                           :weblink,
+                           :solicit,
+                           :thank,
+                           :first_record,
+                           :last_match_date,
+                           :created_date,
+                           :last_updated_date,
+                           :id,
+                           :uri,
+                           :image_uri,
+                           :old_id,
+                           :i_code,
+                           :household_id, #required
+                           :old_household_id,
+                           :attributes,
+                           :addresses,
+                           :communications]
+    end
+    
+  end
+
+end

data/shelby_arena_api.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  PROJECT_GEM = 'shelby-arena-api'
+  PROJECT_GEM_VERSION = '0.1.0'
+  
+  s.name = PROJECT_GEM
+  s.version = PROJECT_GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+
+  s.homepage = 'https://github.com/weshays/shelby-arena-api-ruby'
+  s.rubyforge_project = 'Project on www.github.com'
+  s.authors = ['Wes Hays']
+  s.email = ['weshays@gbdev.com']
+
+  s.summary = 'Ruby gem/plugin to interact with the Shelby Arena API'
+  s.description = 'Ruby gem/plugin to interact with the Shelby Arena API. Checkout the project on github for more detail.'
+
+  s.add_dependency('typhoeus', '0.6.6')
+  s.add_dependency('virtus', '1.0.2')
+
+
+  s.files         = `git ls-files`.split("\n").delete_if { |f| !(f =~ /^examples/).nil? }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/functional/shelby_arena_spec.rb

@@ -0,0 +1,17 @@
+require File.join(Dir.pwd, 'spec', 'spec_helper')
+
+describe 'ShelbyArenaApi' do
+
+  before do
+    #simulate_connection_to_server
+  end
+
+  after do
+
+  end
+
+  it 'should connect successfully'
+
+end
+
+

data/spec/readers/api_reader_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ShelbyArena::ApiReader do
+
+  it 'should pass'
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require File.expand_path( File.dirname(__FILE__) + '/../example/shelby_arena_keys.rb')
+require File.expand_path( File.dirname(__FILE__) + '/../lib/shelby_arena.rb')
+
+require 'debugger'
+
+require 'vcr'
+require 'vcr_setup'
+require 'webmock/rspec'
+
+Dir.glob(File.dirname(__FILE__) + "/factories/*").each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+
+def simulate_connection_to_server
+  ShelbyArena::Api.connect(ShelbyArenaKeys::USERNAME, 
+                           ShelbyArenaKeys::PASSWORD,
+                           ShelbyArenaKeys::API_KEY, 
+                           ShelbyArenaKeys::API_SECRET, 
+                           ShelbyArenaKeys::SHELBY_ARENA_SERVICE_URL)
+end

data/spec/vcr_helper.rb

@@ -0,0 +1,5 @@
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/cassettes'
+  config.hook_into :webmock
+  config.default_cassette_options = { :record => :once, :erb => true }
+end

data/spec/writers/api_writer_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ShelbyArena::ApiWriter do
+
+  it 'should pass'
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: shelby-arena-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wes Hays
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.6
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: Ruby gem/plugin to interact with the Shelby Arena API. Checkout the project
+  on github for more detail.
+email:
+- weshays@gbdev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- docs/ArenaAPI.pdf
+- lib/api/address.rb
+- lib/api/api_object.rb
+- lib/api/contribution.rb
+- lib/api/contribution_list.rb
+- lib/api/family.rb
+- lib/api/fund.rb
+- lib/api/fund_list.rb
+- lib/api/person.rb
+- lib/api/person_list.rb
+- lib/api/shelby_session.rb
+- lib/auto_load.rb
+- lib/common.rb
+- lib/exceptions.rb
+- lib/readers/api_reader.rb
+- lib/readers/contribution_list_reader.rb
+- lib/readers/contribution_reader.rb
+- lib/readers/family_reader.rb
+- lib/readers/fund_list_reader.rb
+- lib/readers/fund_reader.rb
+- lib/readers/person_list_reader.rb
+- lib/readers/person_reader.rb
+- lib/shelby_arena.rb
+- lib/writers/api_writer.rb
+- lib/writers/person_writer.rb
+- shelby_arena_api.gemspec
+- spec/functional/shelby_arena_spec.rb
+- spec/readers/api_reader_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_helper.rb
+- spec/writers/api_writer_spec.rb
+homepage: https://github.com/weshays/shelby-arena-api-ruby
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: Project on www.github.com
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Ruby gem/plugin to interact with the Shelby Arena API
+test_files:
+- spec/functional/shelby_arena_spec.rb
+- spec/readers/api_reader_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_helper.rb
+- spec/writers/api_writer_spec.rb