rock_rms 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04dbe2c1ddc46b1ec79763a420fcbb97cd2ef247
+  data.tar.gz: 02a707ba95cf6cd74d462c01fc071ab32639f027
+SHA512:
+  metadata.gz: 1533f754cc4cd88a2ad823b786e409a2320e596032d8f2d5ca5b7b692b27d87dfa2ae19fdc538ba66ba9cad9efd26e35dae950dddf1576e3d9fa6fe6d43bd9c3
+  data.tar.gz: 25fccae0a610b7f4254ba2f983820521134ebd068d00bff1282ed1e29cdb73d768e4ce0f68aee9ec596ac604bdaa89f947c75841ddc0c91e7661992368ba36d5

data/.gitignore

@@ -0,0 +1,2 @@
+rock_rms-*.gem
+.env

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Taylor Brooks
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+⚠️  Code is highly subject to change. Consider this an alpha release.
+
+### A Ruby wrapper for the Rock RMS API
+
+To get a general overview of Rock RMS: https://www.rockrms.com
+
+To stay up-to-date with the code changes of Rock RMS: https://github.com/SparkDevNetwork/Rock
+
+I'm a big fan of Rock so if you have problems using the gem or would like to see support for new endpoints, please open a GitHub issue -- I'll get it resolved as quick as I can.
+
+### Installation
+Add this line to your application's Gemfile:
+````ruby
+  # in your Gemfile
+  gem 'rock_rms', '~> 0.1'
+
+  # then...
+  bundle install
+````
+
+### Usage
+````ruby
+  client = RockRMS::Client.new(
+    url: ...,
+    username: ...,
+    password: ...,
+  )
+
+  # Find a specific person
+  client.find_person_by_email('gob@bluthco.com')
+  client.find_person_by_name('Tobias Funke')
+````
+
+### History
+
+View the [changelog](https://github.com/taylorbrooks/rock_rms/blob/master/CHANGELOG.md)
+This gem follows [Semantic Versioning](http://semver.org/)
+
+### Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/taylorbrooks/rock_rms/issues)
+- Fix bugs and [submit pull requests](https://github.com/taylorbrooks/rock_rms/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+### Copyright
+Copyright (c) 2017 Taylor Brooks. See LICENSE for details.

data/lib/rock_rms.rb

@@ -0,0 +1,4 @@
+require_relative 'rock_rms/client'
+
+module RockRMS
+end

data/lib/rock_rms/client.rb

@@ -0,0 +1,74 @@
+require 'faraday'
+require 'faraday_middleware'
+require_relative 'version'
+
+Dir[File.expand_path('../resources/*.rb', __FILE__)].each{|f| require f}
+Dir[File.expand_path('../responses/*.rb', __FILE__)].each{|f| require f}
+
+module RockRMS
+  class Client
+    include RockRMS::Client::Donation
+    include RockRMS::Client::Fund
+    include RockRMS::Client::PaymentMethod
+    include RockRMS::Client::Person
+
+    attr_reader :url, :username, :password, :logger, :cookie, :connection
+
+    def initialize(url:, username:, password:, logger: true)
+      @url      = url
+      @username = username
+      @password = password
+      @logger   = logger
+      @cookie   = auth['set-cookie']
+    end
+
+    def auth
+      connection.post("Auth/Login", {
+        'Username'  => username,
+        'Password'  => password,
+        'Persisted' => true
+       })
+    end
+
+    def get(path, options)
+      connection.get(path, options).body
+    end
+
+    def post(path, req_body)
+      connection.post do |req|
+        req.url(path)
+        req.body = req_body
+      end.body
+    end
+
+    def patch(path, options)
+      connection.patch(path, options).body
+    end
+
+    def put(path, options)
+      connection.put(path, options).body
+    end
+
+    def delete(path, options)
+      connection.delete(path, options).body
+    end
+
+    private
+
+    def connection
+      headers = {
+        accept: 'application/json',
+        'User-Agent' => "rock-rms-ruby-gem/v#{RockRMS::VERSION}"
+      }
+
+      headers.merge!('Cookie' => cookie) if cookie
+
+      Faraday.new(url: url, headers: headers) do |conn|
+        conn.request   :json
+        conn.response  :logger if logger
+        conn.response  :json
+        conn.adapter   Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/rock_rms/resources/donation.rb

@@ -0,0 +1,50 @@
+module RockRMS
+  class Client
+    module Donation
+
+      def list_donations(options={})
+        res = get(transaction_path, options)
+        RockRMS::Donation.format(res)
+      end
+
+      def find_donations_by_giving_id(id, raw = false)
+        res = get("FinancialTransactions/GetByGivingId/#{id}?$expand=TransactionDetails")
+        raw ? res : RockRMS::Donation.format(res)
+      end
+
+      def find_donations(id)
+        res = get(transaction_path(id))
+        RockRMS::Donation.format(res)
+      end
+
+      def create_donation(authorized_person_id:, amount:, date:, fund_id:)
+        options = {
+          "TransactionDateTime" => date,
+          "AuthorizedPersonAliasId" => authorized_person_id,
+          "TransactionDetails"  => [{
+            "Amount"    => amount,
+            "AccountId" => fund_id
+          }],
+          "TransactionTypeValueId" => 53, # transaction type "contribution", "registration"
+          "FinancialPaymentDetailId" => 1
+        }
+        post(transaction_path, options)
+      end
+
+      def update_transaction(id, options={})
+        put(transaction_path(id), options)
+      end
+
+      def delete_transaction(id)
+        delete(transaction_path(id))
+      end
+
+      private
+
+      def transaction_path(id = nil)
+        id ? "FinancialTransactions/#{id}" : "FinancialTransactions"
+      end
+
+    end
+  end
+end

data/lib/rock_rms/resources/fund.rb

@@ -0,0 +1,18 @@
+module RockRMS
+  class Client
+    module Fund
+
+      def list_funds(options={})
+        res = get(fund_path, options)
+        RockRMS::Fund.format(res)
+      end
+
+      private
+
+      def fund_path(id = nil)
+        id ? "FinancialAccounts/#{id}" : "FinancialAccounts"
+      end
+
+    end
+  end
+end

data/lib/rock_rms/resources/payment_method.rb

@@ -0,0 +1,16 @@
+module RockRMS
+  class Client
+    module PaymentMethod
+
+      def list_payment_methods(options={})
+        get(payment_method_path, options)
+      end
+
+      private
+
+      def payment_method_path(id = nil)
+        id ? "FinancialPaymentDetails/#{id}" : "FinancialPaymentDetails"
+      end
+    end
+  end
+end

data/lib/rock_rms/resources/person.rb

@@ -0,0 +1,35 @@
+module RockRMS
+  class Client
+    module Person
+      def list_people(options={})
+        res = get(people_path, options)
+        RockRMS::Person.format(res)
+      end
+
+      def find_person(id)
+        res = get(people_path(id))
+        RockRMS::Person.format(res)
+      end
+
+      def find_person_by_email(email)
+        res = get("People/GetByEmail/#{email}")
+        RockRMS::Person.format(res)
+      end
+
+      def find_person_by_name(full_name)
+        res = get("People/Search?name=#{full_name}&includeHtml=false&includeDetails=false&includeBusinesses=false&includeDeceased=false")
+        RockRMS::Person.format(res)
+      end
+
+      def update_person(id, options = {})
+        put(people_path(id), options)
+      end
+
+      private
+
+      def people_path(id = nil)
+        id ? "People/#{id}" : "People"
+      end
+    end
+  end
+end

data/lib/rock_rms/responses/donation.rb

@@ -0,0 +1,21 @@
+module RockRMS
+  class Donation
+    def self.format(response)
+      if response.is_a?(Array)
+        response.map{|donation| format_donation(donation) }
+      else
+        format_donation(response)
+      end
+    end
+
+    def self.format_donation(donation)
+      {
+        id:     donation["Id"],
+        date:   donation["TransactionDateTime"],
+        amount: donation["TransactionDetails"].reduce(0){|sum, td| sum + td["Amount"]},
+        person_id: donation["AuthorizedPersonAliasId"],
+        fund:   ""
+      }
+    end
+  end
+end

data/lib/rock_rms/responses/fund.rb

@@ -0,0 +1,18 @@
+module RockRMS
+  class Fund
+    def self.format(response)
+      if response.is_a?(Array)
+        response.map{|fund| format_fund(fund) }
+      else
+        format_fund(response)
+      end
+    end
+
+    def self.format_fund(fund)
+      {
+        id:   fund["Id"],
+        name: fund["Name"]
+      }
+    end
+  end
+end

data/lib/rock_rms/responses/person.rb

@@ -0,0 +1,23 @@
+module RockRMS
+  class Person
+    def self.format(response)
+      if response.is_a?(Array)
+        response.map{|person| format_person(person) }
+      else
+        format_person(response)
+      end
+    end
+
+    def self.format_person(person)
+      {
+        id:         person["Id"],
+        name:       person["FullName"],
+        email:      person["Email"],
+        first_name: person["FirstName"],
+        last_name:  person["LastName"],
+        giving_id:  person["GivingId"],
+        alias_id:   person["PrimaryAliasId"]
+      }
+    end
+  end
+end

data/lib/rock_rms/version.rb

@@ -0,0 +1,3 @@
+module RockRMS
+  VERSION = "0.0.1"
+end

data/rock_rms.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rock_rms/version"
+require "base64"
+
+Gem::Specification.new do |s|
+  s.name          = "rock_rms"
+  s.version       = RockRMS::VERSION
+  s.authors       = ["Taylor Brooks"]
+  s.email         = ["dGJyb29rc0BnbWFpbC5jb20="].map{ |e| Base64.decode64(e) }
+  s.homepage      = "https://github.com/taylorbrooks/rock_rms"
+  s.summary       = %q{A Ruby wrapper for the Rock RMS API}
+  s.description   = %q{A Ruby wrapper for the Rock RMS API -- a church management platform, simplified.}
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test)/})
+
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency     'faraday'
+  s.add_runtime_dependency     'faraday_middleware'
+  s.add_runtime_dependency     'json'
+
+  s.add_development_dependency 'bundler'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rock_rms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Taylor Brooks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for the Rock RMS API -- a church management platform,
+  simplified.
+email:
+- tbrooks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/rock_rms.rb
+- lib/rock_rms/client.rb
+- lib/rock_rms/resources/donation.rb
+- lib/rock_rms/resources/fund.rb
+- lib/rock_rms/resources/payment_method.rb
+- lib/rock_rms/resources/person.rb
+- lib/rock_rms/responses/donation.rb
+- lib/rock_rms/responses/fund.rb
+- lib/rock_rms/responses/person.rb
+- lib/rock_rms/version.rb
+- rock_rms.gemspec
+homepage: https://github.com/taylorbrooks/rock_rms
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Rock RMS API
+test_files: []