fellowshipone-api 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ef90aa299f36b4c0a571d002270b2ab0b3581b3
+  data.tar.gz: adcedccde6a8ecec28f5ba2d645be7ae5f8226fc
+SHA512:
+  metadata.gz: 6d6ecceef36ccef3d72218b6ab39413eceedf8b094632f5c3f9852cd59215b8e61b69d4ae15bea024e01a21e480ba7ed960af3dd3170d80a602d2fddb45e9185
+  data.tar.gz: 9a7eecf24d55cf41ca22f1a1ff476cc4e0c1787ecd6e8485a5ee8332cb0f83daba2a3c371dba74150a43cfbb073ec8e8acf1cb27f9c0675893ede4603608865b

data/.gitignore

@@ -0,0 +1,3 @@
+fellowshipone-api-*.gem
+access_token.yml
+access_token_marshal.txt

data/.ruby-gemset

@@ -0,0 +1 @@
+fellowshipone-api

data/.ruby-version

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

data/Gemfile

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+gem 'typhoeus', '0.6.6'
+gem 'json'
+gem 'oauth_weshays', '0.4.8.pre2'
+
+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,64 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    columnize (0.3.6)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    debugger (1.6.2)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    diff-lcs (1.2.5)
+    ethon (0.6.1)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
+    factory_girl (4.3.0)
+      activesupport (>= 3.0.0)
+    ffi (1.9.3)
+    i18n (0.6.5)
+    json (1.8.1)
+    mime-types (1.25)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    oauth_weshays (0.4.8.pre2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    safe_yaml (0.9.7)
+    thread_safe (0.1.3)
+      atomic
+    typhoeus (0.6.6)
+      ethon (~> 0.6.1)
+    tzinfo (0.3.38)
+    vcr (2.7.0)
+    webmock (1.9.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  factory_girl
+  json
+  oauth_weshays (= 0.4.8.pre2)
+  rspec
+  typhoeus (= 0.6.6)
+  vcr
+  webmock (= 1.9)

data/README.rdoc

@@ -0,0 +1,44 @@
+= FellowshipOne API
+
+This Ruby project is an API wrapper for the FellowshipOne API (https://developer.fellowshipone.com/)
+
+
+== Install / Setup
+
+Installing the gem
+
+    gem install fellowshipone-api
+
+
+To add it to your Gemfile
+
+    gem 'fellowshipone-api', :require => 'fellowshipone'
+
+
+== Example usage
+
+  Checkout the examples folder.
+
+
+== Additional resources
+
+* FellowshipOne API: https://developer.fellowshipone.com/docs/
+* FellowshipOne Forum: https://developer.fellowshipone.com/forum/
+
+
+== License
+
+This project is released under the MIT license (see LICENSE).
+
+This project is maintained by Wes Hays (https://github.com/weshays).
+
+
+== Contributors
+
+Chad Feller: https://github.com/cfeller
+Taylor Brooks: https://github.com/taylorbrooks
+
+
+== 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/fellowshipone_api.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  PROJECT_GEM = 'fellowshipone-api'
+  PROJECT_GEM_VERSION = '0.6.0'
+  
+  s.name = PROJECT_GEM
+  s.version = PROJECT_GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+
+  s.homepage = 'https://github.com/weshays/fellowshipone-api-ruby'
+  s.rubyforge_project = 'Project on www.github.com'
+  s.authors = ['Wes Hays', 'Chad Feller']
+  s.email = ['weshays@gbdev.com','feller@cs.unr.edu']
+
+  s.summary = 'Ruby gem/plugin to interact with the FellowshipOne API (https://developer.fellowshipone.com/).'
+  s.description = 'Ruby gem/plugin to interact with the FellowshipOne API (https://developer.fellowshipone.com/). Checkout the project on github for more detail.'
+
+  s.add_dependency('typhoeus', '0.6.6')
+  s.add_dependency('oauth_weshays', '0.4.8.pre2')
+
+
+  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/lib/api/api_object.rb

@@ -0,0 +1,141 @@
+module FellowshipOne
+
+  # This class is the base class for all FellowshipOne objects and is meant to be inherited.
+  #
+  class ApiObject 
+    attr_reader :error_messages, :marked_for_destruction
+    
+
+    # Used to specify a list of getters and setters.
+    def self.f1_attr_accessor(*vars)
+      @__f1_attributes ||= []
+      @__f1_attributes.concat(vars)
+      attr_accessor(*vars)
+    end
+
+
+    # A list of f1_attr_accessors that have been specified.
+    def self.__f1_attributes
+      @__f1_attributes
+    end
+
+    # 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 = "#{_attr_underscore(key.to_s)}="
+          if method_to_call.chars.first == "@"
+            method_to_call.reverse!.chop!.reverse!
+          end
+
+          if respond_to?(method_to_call)
+            self.send(method_to_call, value) 
+          end
+          
+        end
+      end     
+    end
+
+
+    # # Returns the status of the current object.
+    # def is_deleted?
+    #   @_deleted ||= false
+    # end
+    
+    # Gets the current object's attributes in a Hash.
+    #
+    # @return A hash of all the attributes.
+    def to_attributes 
+      vals = {}
+      #vals = {:marked_for_destruction => self.is_deleted?} if self.is_deleted?
+      self.class.__f1_attributes.each do |tca| 
+        rep = self.send(tca)               
+        if rep.class == Array   
+          rep.collect! { |r| r.respond_to?(:to_attributes) ? r.to_attributes : r }
+        end
+        vals[_f1ize(tca)] = rep
+      end
+      _map_fields(vals)
+      vals
+    end
+
+
+    # Sets the current object's attributes from a hash
+    def set_attributes(attribute_data)
+      attribute_data.each { |key, value| self.send("#{key}=", value) if self.respond_to?("#{key}=") }
+    end
+
+
+    # Save this object.
+    #
+    # @return True on success, otherwise false.
+    def save
+      raise "@writer_object not set for #{self.class}" if @writer_object.nil?
+      writer = @writer_object.new(self.to_attributes) 
+      result = writer.save_object
+      if result === false
+        @error_messages = writer.error_messages
+      else
+        rkey = self._default_result_key
+        self.initialize_from_json_object(rkey.nil? ? result : result[rkey])
+      end
+      result === false ? false : true
+    end
+
+
+    # # Delete this object.
+    # #
+    # # @return True on success, otherwise false.
+    # def delete
+    #   writer = @writer_object.new(self.to_attributes) 
+    #   result = writer.delete_object
+    #   if result === false
+    #     @error_messages = writer.error_messages
+    #   else
+    #     @_deleted = true
+    #   end
+    #   result === false ? false : true
+    # end    
+
+
+    # This method should be overwritten in the ApiObject subclass.
+    def _field_map
+      {}
+    end
+
+    def _default_result_key
+      self.class.to_s.split('::').last.downcase
+    end
+
+    private
+
+    # Used for mapping FellowshipOne fields that may not match the naming or camelcase 
+    # used, or that is generated.
+    def _map_fields(fields)
+      self._field_map.each do |key1, key2|
+        fields[key2.to_s] = fields[key1.to_s]
+        fields.delete(key1.to_s)
+      end
+    end
+
+
+    def _attr_underscore(str)
+      str.gsub(/::/, '/')
+         .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+         .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+         .tr("-", "_")
+         .downcase
+    end
+
+    def _f1ize(term)
+      term.to_s.split('_').inject([]) { |buffer, e| buffer.push(buffer.empty? ? e : e.capitalize) }.join 
+    end
+    
+  end
+
+end
+
+

data/lib/api/communication.rb

@@ -0,0 +1,59 @@
+module FellowshipOne
+
+  class Communication < ApiObject
+
+    f1_attr_accessor :id,
+                     :uri,
+                     :household,
+                     :person,
+                     :communication_type,
+                     :communication_general_type,
+                     :communication_value,
+                     :search_communication_value,
+                     :preferred,
+                     :communication_comment,
+                     :created_date,
+                     :last_updated_date
+
+    # Load the communication by the specified ID.
+    #
+    # @param communication_id The ID of the communication to load.
+    #
+    # Returns a new Communication object.
+    def self.load_by_id(communication_id)
+      reader = CommunicationReader.new(nil, communication_id)
+      self.new(reader)
+    end
+
+    # Constructor.
+    #
+    # @param person_id The ID of the person to load the communication for.
+    # @param reader (optional) The object that has the data. This can be a CommunicationReader or Hash object.
+    def initialize(person_id, reader = nil)      
+      @writer_object = CommunicationWriter
+      if reader.is_a?(CommunicationReader)
+        initialize_from_json_object(reader.load_feed['communication'])
+      elsif reader.is_a?(Hash)
+        initialize_from_json_object(reader)
+      else # new 
+        reader = CommunicationReader.new(person_id, nil)
+        initialize_from_json_object(reader.load_new['communication'])        
+      end   
+    end
+    
+    def household_id
+      self.household['@id']
+    end
+    
+    def individual_id
+      self.person['@id']
+    end
+    alias_method :person_id, :individual_id
+
+    def _field_map
+      {:id => '@id',
+       :uri => '@uri'}
+    end
+  end
+
+end

data/lib/api/contribution.rb

@@ -0,0 +1,97 @@
+module FellowshipOne
+
+	class Contribution < ApiObject
+
+		f1_attr_accessor :id,
+                     :uri,
+                     :old_id,
+                     :account_reference,
+                     :amount,
+                     :fund,
+                     :sub_fund,
+                     :pledge_drive,
+                     :household,
+                     :person,
+                     :account,
+                     :reference_image,
+                     :batch,
+                     :activity_instance,
+                     :contribution_type,
+                     :contribution_sub_type,
+                     :received_date,
+                     :transmit_date,
+                     :return_date,
+                     :retransmit_date,
+                     :gl_post_date,
+                     :is_split,
+                     :address_verification,
+                     :memo,
+                     :stated_value,
+                     :true_value,
+                     :thank,
+                     :thanked_date,
+                     :is_matched,
+                     :created_date,
+                     :created_by_person,
+                     :last_updated_date,
+                     :last_updated_by_person
+
+    # 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)      
+      @writer_object = ContributionWriter
+      if reader.is_a?(ContributionReader)
+        initialize_from_json_object(reader.load_feed['contributionReceipt'])
+      elsif reader.is_a?(Hash)
+        initialize_from_json_object(reader)
+      else # new 
+        reader = ContributionReader.new
+        initialize_from_json_object(reader.load_new['contributionReceipt'])        
+      end   
+    end
+
+
+    def fund_id
+      self.fund['@id']
+    end
+    
+    def household_id
+    	self.household['@id']
+    end
+    
+    def individual_id
+    	self.person['@id']
+    end
+    alias_method :person_id, :individual_id
+
+    def amount_cents
+      (self.amount.to_f * 100).to_i
+    end
+
+    def instrument_type
+      self.contribution_type['name']
+    end
+
+    def _default_result_key
+      'contributionReceipt'
+    end
+
+    def _field_map
+      {:id => '@id',
+       :uri => '@uri',
+       :oldId => '@oldID'}
+    end
+	end
+
+end