bloomerang_api 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12419c1537204bdc71893c92afe16c7b2a289e01c85ce54bb5abcbe64f98f89f
+  data.tar.gz: f574f0aab37184607b8db02121e3d405fb61ca2a362b710b74f5719dd8032d82
+SHA512:
+  metadata.gz: 3304cdfacf46810a4cbf16a03959626792734d8ded999c85b70707d407927f14239403f98c1a6d579e107c2dfaf20db575c501919c2e96812965765f1660b427
+  data.tar.gz: 05f2d08d94b4cb4a9e4d98641b45a94491f42e108e9ed912f4256adc2abf97b3c7067702389d5e6839bae8c1df5e9f2c2d72b0ee229a13d2aff3aa26dc373a54

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+  rubocop: warning
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-03-10
+
+- Initial release by [@allynfolksjr](https://github.com/allynfolksjr) from https://github.com/mcsweeneys/bloomerang with base classes:
+  - constituent
+  - fund
+  - transaction
+
+## [0.2.0] - 2023-01-21
+
+- Release by [@chiperific](https://github.com/chiperific/) from https://github.com/chiperific/bloomerang_api
+- Breaking changes from v0.1.0:
+  - Rename `#all` methods to `#fetch`
+  - Rename `#show` methods to  `#get`
+- Addition of the following classes:
+  - address
+  - appeal
+  - campaign
+  - custom_field
+  - email
+  - email_interest
+  - household
+  - interaction
+  - note
+  - phone
+  - pledge
+  - refund
+  - relationship
+  - soft-credit
+  - tribute
+  - task
+- Updates to the following classes:
+  - constituent
+  - fund
+  - transaction
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+As members, contributors, and leaders, we pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to chiperific@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bloomerang.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    bloomerang_api (0.2.0)
+      faraday (>= 2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bloomerang_api!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Nikky Southerland
+
+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,204 @@
+# Bloomerang
+
+This is an unofficial [bloomerang.co REST API v2](https://bloomerang.co/product/integrations-data-management/api/rest-api/) client for Ruby.
+
+
+_Note: you must be a Bloomerang customer with an active account to access the API_
+
+This gem is based upon the initial work of [@allynfolksjr](https://github.com/allynfolksjr) at https://github.com/mcsweeneys/bloomerang. They added limited endpoint support for:
+
+* Constituent
+* Fund
+* Transaction
+
+This gem adds support [__all__ other endpoints](https://github.com/chiperific/bloomerang_api/tree/main/lib/bloomerang), _except_:
+
+* Processor
+* User
+* WalletItem
+
+
+## Installation for Ruby on Rails:
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "bloomerang_api", "~> 0.2"
+```
+
+And then execute:
+
+`$ bundle install`
+
+Or install it yourself as:
+
+`$ gem install bloomerang_api`
+
+## Setup
+
+1. Get your Bloomerang API Key:
+
+- Generate your v2.0 API key from [your Bloomerang user settings](https://crm.bloomerang.co/Settings/User/Edit)
+
+2. Add your API key to your app using a secure method:
+
+- [Credentials](https://edgeguides.rubyonrails.org/security.html#custom-credentials) strategy (preferred):
+    ```yaml
+    # ./config/credentials.yml
+    bloomerang:
+      api_key: myapikey
+    ```
+
+- [dotenv](https://github.com/bkeepers/dotenv) strategy:
+    ```ruby
+    # ./.env
+    BLOOMERANG_API_KEY=myapikey
+    ```
+
+- [ENV](https://blog.devgenius.io/what-are-environment-variables-in-rails-6f7e97a0b164) strategy:
+    ```bash
+    $ export BLOOMERANG_API_KEY=myapikey
+    ```
+
+3. Run the generator to create the initializer file:
+
+```bash
+$ rails generate bloomerang:initializer
+```
+
+### WARNING: NO SANDBOX, PRODUCTION ONLY
+
+Bloomerang does not offer a sandbox environment or any way to test API calls without actually affecting your production data.
+
+__Any POST, PUT and DELETE requests will be run against your live Bloomerang account!__
+
+[Please encourage Bloomerang](https://crm.bloomerang.co/Home/FeaturesPortal) to address this issue.
+
+## Usage
+
+The standard structure of all endpoints is as follows:
+
+- Reading records:
+    - `#fetch`: a GET request that returns a batch of records, 50 by default (see paging/batching below for more)
+    - `#get`: a GET request returns a single record that matches the provided ID
+
+- Creating, updating and deleting records:
+    - `#create`: a POST request that creates a record based on the provided `body` variable.
+    - `#update`: a PUT request that updates a record
+    - `#delete`: a DELETE request that deletes a record
+
+__It is highly recommended to reference the [documentation](https://bloomerang.co/product/integrations-data-management/api/rest-api) to identify required and allowed attributes.__
+
+Some `Class`es have custom endpoints. For example:
+
+- `Bloomerang::Campaign.refresh_summaries`
+- `Bloomerang::Constituent.fetch_relationships`
+- `Bloomerang::Constituent.update_communication_settings`
+- `Bloomerang::Constituent.search`
+- `Bloomerang::CustomField.categories`
+
+You can check [the specific class](https://github.com/chiperific/bloomerang_api/tree/main/lib/bloomerang) to check for availble methods.
+
+### GET requests:
+Most Bloomerang GET requests have URL parameters that can be set.
+
+Each `Class` documents the available parameters you can append to `GET` requests, you can also check each endpoints [documentation](https://bloomerang.co/product/integrations-data-management/api/rest-api)
+
+#### Paging / Batching support:
+
+`#search` methods, `#fetch` methods, and methods that start with `#fetch_` have two parameters in common that allow you to fetch results in batches:
+
+- `skip` - defaults to 0, the number of records to "skip" before returning results
+- `take` - defaults to 50, the number of records to return.
+
+Responses will include the total number of results available. For example:
+
+```ruby
+params = { skip: 0, take: 50 }
+first_fifty_constituents = Bloomerang::Constituent.fetch(params)
+```
+
+The result will include these keys:
+
+```json
+{
+  "Total": 1850,
+  "TotalFiltered": 1850,
+  "Start": 0,
+  "ResultCount": 50,
+  "Results": [
+    { ...
+```
+
+`"Start"` should be equal to `skip` and `"ResultCount` should be equal to `take`.
+
+Increase your `skip` value by your `take` value to get the next page/batch of records:
+
+```ruby
+params = { skip: 50, take: 50 }
+first_fifty_constituents = Bloomerang::Constituent.fetch(params)
+```
+
+```json
+{
+  "Total": 1850,
+  "TotalFiltered": 1850,
+  "Start": 50,
+  "ResultCount": 50,
+  "Results": [
+    { ...
+```
+
+### POST/PUT/DELETE requests:
+__WARNING: Bloomerang has no test/sandbox feature!__
+
+Any POST, PUT and DELETE requests will be run against your live Bloomerang account!
+
+__Proceed with caution!__
+
+
+`#update`, and `#delete` methods require a record ID and a `body` object. Not all `Class`es implement a `#delete` endpoint.
+
+`#create` methods require only a `body` object.
+
+__It is highly recommended to reference the [documentation](https://bloomerang.co/product/integrations-data-management/api/rest-api) to identify required and allowed attributes.__
+
+## Examples
+
+```ruby
+# fetch the first 50 individual constituents
+params = { skip: 0, take: 50, type: "Individual" }
+Bloomerang::Constituent.fetch(params)
+
+# fetch the next 50 individual constituents
+params = { skip: 50, take: 50, type: "Individual" }
+Bloomerang::Constituent.fetch(params)
+
+# get the email addresses (first 50) for a constituent
+params = { constituent: "12345" }
+Bloomerang::Email.fetch(params)
+
+# create a task
+body = {
+  "DueDate": "2023-01-21",
+  "Subject": "Schedule meeting",
+  "Note": "Schedule a meeting with Tom and Sidney to request a renewed family foundation gift",
+  "Channel": "Email",
+  "Purpose": "ImpactCultivation",
+  "UserId": 12, # the ID of the user responsible for the task
+  "AccountId": 123456, # the ID of the constituent related to the task
+}
+Bloomerang::Task.create(body)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/chiperific/bloomerang_api/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bloomerang API project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/chiperific/bloomerang_api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bloomerang"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bloomerang/address.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Bloomerang
+  ### Bloomerang::Address
+  ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses
+  # Id                integer($int64)
+  # AccountId         integer($int64) The ID of the constituent used in the API (not to be confused with accountNumber)
+  # Type              AddressType Enum: [ Home, Vacation, Work ]
+  # Street            string
+  # City              string
+  # State             string Must match a state in the Bloomerang CRM
+  # PostalCode        string
+  # Country           string Must match a country in the Bloomerang CRM
+  # IsPrimary         boolean
+  # IsBad             boolean
+  # StateAbbreviation string The 2-3 letter abbreviation for the state/province
+  # CountryCode       string The 2 letter ISO code for the country
+  class Address < Base
+    ### Fetch all addresses
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses/get_addresses
+    #
+    ## Params:
+    # skip        integer, default: 0,  simple paging system
+    # take        integer, default: 50, simple paging system
+    # constituent array[integer], separated by pipes: "1|2|3"
+    # id          array[integer], separated by pipes: "1|2|3"
+    def fetch(params = {})
+      get("addresses", params)
+    end
+
+    ### Show an address
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses/get_address__id_
+    #
+    ## Params:
+    # id integer
+    def get(id)
+      get("addresses/#{id}")
+    end
+
+    ### Create an address
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses/post_address
+    #
+    # Params:
+    # body  see API for fields
+    def create(body)
+      post("address", {}, body)
+    end
+
+    ### Update an address
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses/put_address__id_
+    #
+    # Params:
+    # id    integer
+    # body  see API for fields
+    def update(id, body)
+      put("address/#{id}", {}, body)
+    end
+
+    ### Delete an address
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses/delete_address__id_
+    #
+    # Params:
+    # id   integer
+    def delete(id)
+      delete("address/#{id}", {})
+    end
+  end
+end

data/lib/bloomerang/appeal.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Bloomerang
+  ### Bloomerang::Appeal
+  ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Appeals
+  # Id        integer($int64)
+  # Name      string
+  # SortIndex integer($int32)
+  # IsActive  boolean
+  class Appeal < Base
+    ### Fetch all appeals
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Appeals/get_appeals
+    #
+    # Params:
+    # skip        integer, default: 0,  simple paging system
+    # take        integer, default: 50, simple paging system
+    # id          array[integer], separated by pipes: "1|2|3"
+    # isActive    boolean, Filters to either active or inactive appeals
+    # search      string, Filters to appeals with names that match any part of the search string
+    def fetch(params)
+      get("appeals", params)
+    end
+
+    ### Show an appeal
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Appeals/get_appeal__id_
+    #
+    # Params:
+    # id  integer
+    def get(id)
+      get("appeal/#{id}")
+    end
+
+    ### Create an appeal
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Appeals/post_appeal
+    #
+    # Params:
+    # body  see API for fields
+    def create(body)
+      post("appeal", {}, body)
+    end
+
+    ### Update an appeal
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Appeals/put_appeal__id_
+    #
+    # Params:
+    # id    integer
+    # body  see API for fields
+    def update(id, body)
+      put("appeal/#{id}", {}, body)
+    end
+  end
+end

data/lib/bloomerang/base.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+module Bloomerang
+  ## Bloomerang::Base
+  # Primary interface for Faraday
+  class Base
+    API_URL = "https://api.bloomerang.co/v2"
+    API_KEY = ENV["BLOOMERANG_API_KEY"]
+
+    def get(path, params = {})
+      response = connection(params).get(path)
+      JSON.parse response.body
+    end
+
+    def delete(path, params = {})
+      response = connection(params).delete(path)
+      JSON.parse response.body
+    end
+
+    def post(path, params, body)
+      response = connection(params).post(path, body.to_json)
+      JSON.parse response.body
+    end
+
+    def put(path, params, body)
+      response = connection(params).put(path, body.to_json)
+      JSON.parse response.body
+    end
+
+    private
+
+    def connection(params)
+      Faraday.new(
+        url: API_URL,
+        headers: {
+          "Content-Type" => "application/json",
+          "X-API-Key" => API_KEY
+        },
+        params: params
+      )
+    end
+  end
+end