bloomerang_api 0.2.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12419c1537204bdc71893c92afe16c7b2a289e01c85ce54bb5abcbe64f98f89f
-  data.tar.gz: f574f0aab37184607b8db02121e3d405fb61ca2a362b710b74f5719dd8032d82
+  metadata.gz: 1115ff6cbfd710e29125b2f1dffd2c3a0406f650cab18e5188d92f64384469cf
+  data.tar.gz: 2329d69106766e001d2bd55376a040f5a0ccda7a3e3117f7e33b519c85bc6200
 SHA512:
-  metadata.gz: 3304cdfacf46810a4cbf16a03959626792734d8ded999c85b70707d407927f14239403f98c1a6d579e107c2dfaf20db575c501919c2e96812965765f1660b427
-  data.tar.gz: 05f2d08d94b4cb4a9e4d98641b45a94491f42e108e9ed912f4256adc2abf97b3c7067702389d5e6839bae8c1df5e9f2c2d72b0ee229a13d2aff3aa26dc373a54
+  metadata.gz: 6402efa8347325f403db5f3e9362533ccf0f522678599bff1642a28ef1786a0931f7fc7f6e332390d15b71b8dcca21bf6d645e41107c6ff1155cd8d2c4b12a58
+  data.tar.gz: 1423f68406509952f130961e78b0e70582d51bf77ada6541fe93a854536f3b3b9552a7ecb5cdba33c0b05a91cc96a083c6d1a0b2c016c69f11d93063eb690b9a

data/README.md

@@ -7,15 +7,15 @@ _Note: you must be a Bloomerang customer with an active account to access the AP
 
 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
+  * Constituent
+  * Fund
+  * Transaction
 
-This gem adds support [__all__ other endpoints](https://github.com/chiperific/bloomerang_api/tree/main/lib/bloomerang), _except_:
+This gem adds support for [all other endpoints](https://github.com/chiperific/bloomerang_api/tree/main/lib/bloomerang), _except_:
 
-* Processor
-* User
-* WalletItem
+  * Processor
+  * User
+  * WalletItem
 
 
 ## Installation for Ruby on Rails:
@@ -23,42 +23,41 @@ This gem adds support [__all__ other endpoints](https://github.com/chiperific/bl
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "bloomerang_api", "~> 0.2"
+gem "bloomerang_api", "~> 1.0"
 ```
 
 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)
+  - 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
-    ```
+  - [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
+      ```
 
-- [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:
 
-- [ENV](https://blog.devgenius.io/what-are-environment-variables-in-rails-6f7e97a0b164) strategy:
-    ```bash
-    $ export BLOOMERANG_API_KEY=myapikey
-    ```
+      ```bash
+      $ export BLOOMERANG_API_KEY=myapikey
+      ```
 
 3. Run the generator to create the initializer file:
 
@@ -66,28 +65,56 @@ Or install it yourself as:
 $ rails generate bloomerang:initializer
 ```
 
+This will create the file `./config/initializers/bloomerang.rb` where you can set your API key:
+
+```ruby
+require 'bloomerang'
+
+Bloomerang.configure do |config|
+  ### Set your Bloomerang API key:
+  # Generate your v2.0 API key from your Bloomerang user settings:
+  # https://crm.bloomerang.co/Settings/User/Edit
+  #
+  # UNSECURE: DO NOT ADD THE KEY DIRECTLY TO THIS FILE!
+  # It will be exposed in your source code.
+  # Instead, use a secure method to store your API key
+  #
+  # Rails credentials example (preferred):
+  # Learn about encrypted credentials: https://edgeguides.rubyonrails.org/security.html#custom-credentials
+  # config.api_key = Rails.application.credentials.dig(:bloomerang, :api_key)
+  #
+  # ENV or dotenv example:
+  # Learn about dotenv gem: https://github.com/bkeepers/dotenv
+  # config.api_key = ENV["BLOOMERANG_API_KEY"]
+end
+```
+
+## Usage
+
+:point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down::point_down:
+
 ### 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
+***Any POST, PUT and DELETE requests will be run against your live Bloomerang account!***
 
-The standard structure of all endpoints is as follows:
+:point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2::point_up_2:
+
+### Standard structure:
 
 - 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
+  - `#fetch`: a GET request that returns a batch of records, 50 by default (see paging/batching below for more)
+  - `#show`: 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
+  - `#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.__
+  __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:
 
@@ -97,12 +124,12 @@ Some `Class`es have custom endpoints. For example:
 - `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.
+Check [the specific class](https://github.com/chiperific/bloomerang_api/tree/main/lib/bloomerang) for available methods.
 
 ### GET requests:
-Most Bloomerang GET requests have URL parameters that can be set.
+Most 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)
+[Each `Class`](https://github.com/chiperific/bloomerang_api/tree/main/lib/bloomerang) lists 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:
 
@@ -122,12 +149,11 @@ The result will include these keys:
 
 ```json
 {
-  "Total": 1850,
-  "TotalFiltered": 1850,
+  "Total": 1850, // All records in the database
+  "TotalFiltered": 1850, // All records that match query/filters
   "Start": 0,
   "ResultCount": 50,
-  "Results": [
-    { ...
+  "Results": []
 ```
 
 `"Start"` should be equal to `skip` and `"ResultCount` should be equal to `take`.
@@ -136,25 +162,21 @@ Increase your `skip` value by your `take` value to get the next page/batch of re
 
 ```ruby
 params = { skip: 50, take: 50 }
-first_fifty_constituents = Bloomerang::Constituent.fetch(params)
+next_fifty_constituents = Bloomerang::Constituent.fetch(params)
 ```
 
 ```json
 {
-  "Total": 1850,
-  "TotalFiltered": 1850,
+  "Total": 1850, // All records in the database
+  "TotalFiltered": 1850, // All records that match query/filters
   "Start": 50,
   "ResultCount": 50,
-  "Results": [
-    { ...
+  "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!__
+***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.

data/lib/bloomerang/address.rb

@@ -26,7 +26,7 @@ module Bloomerang
     # 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 = {})
+    def self.fetch(params = {})
       get("addresses", params)
     end
 
@@ -35,7 +35,7 @@ module Bloomerang
     #
     ## Params:
     # id integer
-    def get(id)
+    def self.show(id)
       get("addresses/#{id}")
     end
 
@@ -44,7 +44,7 @@ module Bloomerang
     #
     # Params:
     # body  see API for fields
-    def create(body)
+    def self.create(body)
       post("address", {}, body)
     end
 
@@ -54,7 +54,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("address/#{id}", {}, body)
     end
 
@@ -63,7 +63,7 @@ module Bloomerang
     #
     # Params:
     # id   integer
-    def delete(id)
+    def self.delete(id)
       delete("address/#{id}", {})
     end
   end

data/lib/bloomerang/appeal.rb

@@ -19,7 +19,7 @@ module Bloomerang
     # 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)
+    def self.fetch(params)
       get("appeals", params)
     end
 
@@ -28,7 +28,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("appeal/#{id}")
     end
 
@@ -37,7 +37,7 @@ module Bloomerang
     #
     # Params:
     # body  see API for fields
-    def create(body)
+    def self.create(body)
       post("appeal", {}, body)
     end
 
@@ -47,7 +47,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("appeal/#{id}", {}, body)
     end
   end

data/lib/bloomerang/base.rb

@@ -7,40 +7,39 @@ 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 = {})
+    def self.get(path, params = {})
       response = connection(params).get(path)
       JSON.parse response.body
     end
 
-    def delete(path, params = {})
+    def self.delete(path, params = {})
       response = connection(params).delete(path)
       JSON.parse response.body
     end
 
-    def post(path, params, body)
+    def self.post(path, params, body)
       response = connection(params).post(path, body.to_json)
       JSON.parse response.body
     end
 
-    def put(path, params, body)
+    def self.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
-      )
+    class << self
+      private
+
+      def connection(params)
+        Faraday.new(
+          url: Bloomerang.configuration.api_url,
+          headers: {
+            "Content-Type" => "application/json",
+            "X-API-Key" => Bloomerang.configuration.api_key
+          },
+          params: params
+        )
+      end
     end
   end
 end

data/lib/bloomerang/campaign.rb

@@ -26,7 +26,7 @@ module Bloomerang
     # IsActive  boolean
     # search    string, returns matches on any part of name
     # hasGoal   boolean, have either non-zero-dollar or zero-dollar goals
-    def fetch(params = {})
+    def self.fetch(params = {})
       get("campaigns", params)
     end
 
@@ -35,7 +35,7 @@ module Bloomerang
     #
     # Params:
     # id integer
-    def get(id)
+    def self.show(id)
       get("campaign/#{id}")
     end
 
@@ -45,7 +45,7 @@ module Bloomerang
     ## Params:
     # id   integer
     # body JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("campaign/#{id}", {}, body)
     end
 
@@ -54,7 +54,7 @@ module Bloomerang
     #
     ## Params:
     # body JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("campaign", {}, body)
     end
 
@@ -64,7 +64,7 @@ module Bloomerang
     # Returns: JSON: The list of campaigns that are active and have a non-zero goal.
     #
     ## Params: none
-    def refresh_summaries
+    def self.refresh_summaries
       get("campaigns/refreshsummaries")
     end
   end

data/lib/bloomerang/configuration.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
 module Bloomerang
+  ## Bloomerang::Configuration
   class Configuration
-    attr_accessor :api_key
+    attr_accessor :api_key, :api_url
+
+    def initialize
+      @api_url = "https://api.bloomerang.co/v2"
+      @api_key = nil
+    end
   end
 end

data/lib/bloomerang/constituent.rb

@@ -53,8 +53,6 @@ module Bloomerang
   # CustomValues                  array[Objects], Objects are either OneValueAssignment or MultipleValueAssignments
   # AuditTrail                    AuditTrail (Object)
   class Constituent < Base
-    # for backwards compatability
-
     ### Fetch all constituents
     ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/get_constituents
     #
@@ -67,8 +65,7 @@ module Bloomerang
     # id              array[integer], separated by pipes: "1|2|3"
     # orderBy         string, Available values : Id (default), CreatedDate, LastModifiedDate
     # orderDirection  string, Available values : Asc, Desc
-    def fetch(params = {})
-      # TODO: BREAKING CHANGE: used to accept no arguments
+    def self.fetch(params = {})
       get("constituents", params)
     end
 
@@ -77,7 +74,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("constituent/#{id}")
     end
 
@@ -90,7 +87,7 @@ module Bloomerang
     # id      integer
     #
     # Returns: array of Relationships
-    def fetch_relationships(id, params = {})
+    def self.fetch_relationships(id, params = {})
       get("constituent/#{id}/relationships", params)
     end
 
@@ -104,7 +101,7 @@ module Bloomerang
     # id      integer
     #
     # Returns: paged list of TimelineEntrySummary models
-    def fetch_timeline(id, params = {})
+    def self.fetch_timeline(id, params = {})
       get("constituent/#{id}/timeline", params)
     end
 
@@ -114,7 +111,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  see API for fields
-    def update_communication_settings(id, body)
+    def self.update_communication_settings(id, body)
       put("/constituent/#{id}/updateCommunicationSettings", {}, body)
     end
 
@@ -125,7 +122,7 @@ module Bloomerang
     # skip    integer, default: 0,  simple paging system
     # take    integer, default: 50, simple paging system
     # search  string, searches on Full Name with
-    def search(params = {})
+    def self.search(params = {})
       get("constituents/search", params)
     end
 
@@ -144,7 +141,7 @@ module Bloomerang
     # there is a create-only endpoint, but
     # given the risk of duplicate records, this should be the default method
     # for create-only over merge-or-create
-    def create(body)
+    def self.create(body)
       # "When merging, the database will look for a possible duplicate defined as a
       # name plus one piece of contact info (address, email, or phone). If a duplicate
       # is found, the data passed in will be merged into an existing constituent.
@@ -167,7 +164,7 @@ module Bloomerang
     # A more secure pattern would be to create the Constituent
     # then use the returned Constituent ID to check for Emails, Addresses and Phones,
     # and add records if necessary
-    def create_with_secondary(body)
+    def self.create_with_secondary(body)
       post("constituent", {}, body)
     end
 
@@ -177,7 +174,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("constituent/#{id}", {}, body)
     end
 
@@ -190,7 +187,7 @@ module Bloomerang
     # NOTE: There is a GET version as well,
     # but POST was chosen for future Model usage
     # e.g. body = Constituent.duplicate_check_attributes
-    def find_duplicates(body)
+    def self.find_duplicates(body)
       post("constituent/duplicates", {}, body)
     end
 
@@ -199,7 +196,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def delete(id)
+    def self.delete(id)
       delete("constituent/#{id}")
     end
   end

data/lib/bloomerang/custom_field.rb

@@ -12,13 +12,13 @@ module Bloomerang
   # DataType    CustomFieldDataType (object): string, Enum: [ Currency, Date, Decimal, Text, Year ]
   # PickType    CustomFieldPickType (object): string, Enum: [ Freeform, PickMultiple, PickOne ]
   # SortIndex   integer($int32)
-  class CustomField
+  class CustomField < Base
     ### Fetch CustomField Categories by type
     ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Custom%20Fields/get_customFieldCategories__type__
     #
     # Params:
     # type  string, Available values: Constituent, Transaction, Interaction, Note, Benevon
-    def categories(type)
+    def self.categories(type)
       get("/customFieldCategories/#{type}/")
     end
 
@@ -28,7 +28,7 @@ module Bloomerang
     # Params:
     # type      string, Available values: Constituent, Transaction, Interaction, Note, Benevon
     # isActive  boolean, Default value: true
-    def fields(type, params = {})
+    def self.fields(type, params = {})
       get("/customFields/#{type}/", params)
     end
 
@@ -38,7 +38,7 @@ module Bloomerang
     # Params:
     # type      string, Available values : Constituent, Transaction, Interaction, Note, Benevon
     # isActive  boolean, Default value: true
-    def values(type, params = {})
+    def self.values(type, params = {})
       get("/customValues/#{type}/", params)
     end
 
@@ -49,7 +49,7 @@ module Bloomerang
     # type      string, Available values : Constituent, Transaction, Interaction, Note, Benevon
     # fieldId   integer
     # isActive  boolean, Default value: true
-    def values_by_field(type, field_id, params = {})
+    def self.values_by_field(type, field_id, params = {})
       get("/customValues/#{type}/#{field_id}", params)
     end
   end

data/lib/bloomerang/email.rb

@@ -20,7 +20,7 @@ module Bloomerang
     # 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 = {})
+    def self.fetch(params = {})
       get("emails", params)
     end
 
@@ -29,7 +29,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("email/#{id}")
     end
 
@@ -38,7 +38,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("email", {}, body)
     end
 
@@ -48,7 +48,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("email/#{id}", {}, body)
     end
 
@@ -57,7 +57,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def delete(id)
+    def self.delete(id)
       delete("email/#{id}")
     end
   end

data/lib/bloomerang/email_interest.rb

@@ -20,7 +20,7 @@ module Bloomerang
     # take      integer, default: 50, simple paging system
     # id        array[integer], separated by pipes: "1|2|3"
     # isActive  boolean
-    def fetch(params = {})
+    def self.fetch(params = {})
       get("emailInterests", params)
     end
 
@@ -29,7 +29,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("emailInterest/#{id}")
     end
   end

data/lib/bloomerang/fund.rb

@@ -20,7 +20,7 @@ module Bloomerang
     # id            array[integer], separated by pipes: "1|2|3"
     # isActive      boolean
     # search        string, Filters to funds with names that match any part of the search string
-    def fetch(params = {})
+    def self.fetch(params = {})
       get("funds", params)
     end
 
@@ -29,7 +29,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("fund/#{id}")
     end
 
@@ -38,7 +38,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("fund", {}, body)
     end
 
@@ -48,7 +48,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("fund/#{id}", {}, body)
     end
   end

data/lib/bloomerang/household.rb

@@ -28,7 +28,7 @@ module Bloomerang
     # take            integer, default: 50, simple paging system
     # lastModified    string, date in iso8601 format, Filters to constituents last modified after the specified date
     # id              array[integer], separated by pipes: "1|2|3"
-    def fetch(params = {})
+    def self.fetch(params = {})
       get("households", params)
     end
 
@@ -37,7 +37,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("household/#{id}")
     end
 
@@ -48,7 +48,7 @@ module Bloomerang
     # skip    integer, default: 0,  simple paging system
     # take    integer, default: 50, simple paging system
     # search  string, searches on household name and constituent full name, matches any part of string
-    def search(params = {})
+    def self.search(params = {})
       # TODO: BREAKING CHANGE: query changed to params
       Constituent.search(params)
     end
@@ -58,7 +58,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("household", {}, body)
     end
 
@@ -68,7 +68,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("household/#{id}", {}, body)
     end
 
@@ -77,7 +77,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def delete(id)
+    def self.delete(id)
       delete("household/#{id}")
     end
 
@@ -87,7 +87,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body JSON object, see API for fields
-    def update_communication_settings(id, body)
+    def self.update_communication_settings(id, body)
       put("household/#{id}/updateCommunicationSettings", {}, body)
     end
   end

data/lib/bloomerang/interaction.rb

@@ -38,7 +38,7 @@ module Bloomerang
     # id              array[integer], separated by pipes: "1|2|3"
     # orderBy         string, Available values : Id (default), CreatedDate, LastModifiedDate
     # orderDirection  string, Available values : Asc, Desc
-    def fetch(params = {})
+    def self.fetch(params = {})
       get("interactions", params)
     end
 
@@ -47,7 +47,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("interaction", {}, body)
     end
 
@@ -56,7 +56,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("interaction/#{id}")
     end
 
@@ -66,7 +66,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("interaction/#{id}", {}, body)
     end
 
@@ -75,7 +75,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def delete(id)
+    def self.delete(id)
       delete("interaction/#{id}")
     end
   end

data/lib/bloomerang/note.rb

@@ -21,7 +21,7 @@ module Bloomerang
     # id              array[integer], separated by pipes: "1|2|3"
     # orderBy         string, Available values : Id (default), CreatedDate, LastModifiedDate
     # orderDirection  string, Available values : Asc, Desc
-    def fetch(params = {})
+    def self.fetch(params = {})
       get("notes", params)
     end
 
@@ -30,7 +30,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("note", {}, body)
     end
 
@@ -39,7 +39,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("note/#{id}")
     end
 
@@ -49,7 +49,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("note/#{id}", {}, body)
     end
 
@@ -58,7 +58,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def delete(id)
+    def self.delete(id)
       delete("note/#{id}")
     end
   end

data/lib/bloomerang/phone.rb

@@ -18,7 +18,7 @@ module Bloomerang
     # 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 = {})
+    def self.fetch(params = {})
       get("phones", params)
     end
 
@@ -27,7 +27,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("phone", {}, body)
     end
 
@@ -36,7 +36,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("phone/#{id}")
     end
 
@@ -46,7 +46,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("phone/#{id}", {}, body)
     end
 
@@ -55,7 +55,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def delete(id)
+    def self.delete(id)
       delete("phone/#{id}")
     end
   end

data/lib/bloomerang/pledge.rb

@@ -42,7 +42,7 @@ module Bloomerang
     # skip            integer, default: 0,  simple paging system
     # take            integer, default: 50, simple paging system
     # id              array[integer], separated by pipes: "1|2|3"
-    def fetch_installments(id, params = {})
+    def self.fetch_installments(id, params = {})
       get("pledge/#{id}/installments", params)
     end
 
@@ -57,7 +57,7 @@ module Bloomerang
     # frequency             string, Available values : Weekly, EveryOtherWeekly, TwiceMonthly, Monthly, EveryOtherMonthly, Quarterly, Yearly, Custom
     # day1                  integer, Day1 & Day2 are only used with the TwiceMonthly frequency. If specified, day1 must be equal to the day value in firstInstallmentDate. If not specified, day1 will be set to the day value in firstInstallmentDate.
     # day2                  integer, Day1 & Day2 are only used with the TwiceMonthly frequency
-    def generate_installments(params = {})
+    def self.generate_installments(params = {})
       get("pledge/generateInstallments", params)
     end
 
@@ -68,7 +68,7 @@ module Bloomerang
     # skip            integer, default: 0,  simple paging system
     # take            integer, default: 50, simple paging system
     # id              array[integer], separated by pipes: "1|2|3"
-    def fetch_payments(id, params = {})
+    def self.fetch_payments(id, params = {})
       get("pledge/#{id}/payments", params)
     end
 
@@ -79,7 +79,7 @@ module Bloomerang
     # skip            integer, default: 0,  simple paging system
     # take            integer, default: 50, simple paging system
     # id              array[integer], separated by pipes: "1|2|3"
-    def fetch_failed_payments(id, params = {})
+    def self.fetch_failed_payments(id, params = {})
       get("pledge/#{id}/paymentFailures", params)
     end
 
@@ -88,7 +88,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def write_off(id)
+    def self.write_off(id)
       post("pledge/#{id}/writeOff")
     end
   end

data/lib/bloomerang/refund.rb

@@ -9,7 +9,7 @@ module Bloomerang
   # Date          string($date), iso8601 format
   # Amount        number($currency)
   # AuditTrail    AuditTrail  (object)
-  class Refund
+  class Refund < Base
     ### Fetch all refunds
     ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Refunds/get_refunds
     #
@@ -20,7 +20,7 @@ module Bloomerang
     # id              array[integer], separated by pipes: "1|2|3"
     # orderBy         string, Available values : Id (default), CreatedDate, LastModifiedDate
     # orderDirection  string, Available values : Asc, Desc
-    def fetch(params = {})
+    def self.fetch(params = {})
       get("refunds", params)
     end
 
@@ -29,7 +29,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("refund", {}, body)
     end
 
@@ -38,7 +38,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("refund/#{id}")
     end
 
@@ -48,7 +48,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("refund/#{id}", {}, body)
     end
 
@@ -57,7 +57,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def delete(id)
+    def self.delete(id)
       delete("refund/#{id}")
     end
   end

data/lib/bloomerang/relationship.rb

@@ -22,7 +22,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("relationship", {}, body)
     end
 
@@ -31,7 +31,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("relationship/#{id}")
     end
 
@@ -41,7 +41,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("relationship/#{id}", {}, body)
     end
 
@@ -50,7 +50,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def delete(id)
+    def self.delete(id)
       delete("relationship/#{id}")
     end
 
@@ -64,7 +64,7 @@ module Bloomerang
     # id              array[integer], separated by pipes: "1|2|3"
     # name            array[string], Filters to relationship roles with the names in the list (pipe-separated)
     # isActive        boolean, Filters to either active or inactive relationship roles
-    def fetch_roles(params = {})
+    def self.fetch_roles(params = {})
       get("relationshiproles", params)
     end
 
@@ -73,7 +73,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get_role(role_id)
+    def self.get_role(role_id)
       get("relationshiprole/#{role_id}")
     end
   end

data/lib/bloomerang/soft_credit.rb

@@ -20,7 +20,7 @@ module Bloomerang
     # id              array[integer], separated by pipes: "1|2|3"
     # orderBy         string, Available values : Id (default), CreatedDate, LastModifiedDate
     # orderDirection  string, Available values : Asc, Desc
-    def fetch(params = {})
+    def self.fetch(params = {})
       get("softcredits", params)
     end
 
@@ -29,7 +29,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("softcredit", {}, body)
     end
 
@@ -38,7 +38,7 @@ module Bloomerang
     #
     # Params
     # id  integer
-    def get(id)
+    def self.show(id)
       get("softcredit/#{id}")
     end
 
@@ -48,7 +48,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("softcredit/#{id}", {}, body)
     end
 
@@ -57,7 +57,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def delete(id)
+    def self.delete(id)
       delete("softcredit/#{id}")
     end
   end

data/lib/bloomerang/task.rb

@@ -33,7 +33,7 @@ module Bloomerang
     # id              array[integer], separated by pipes: "1|2|3"
     # orderBy         string, Available values : Id (default), CreatedDate, LastModifiedDate
     # orderDirection  string, Available values : Asc, Desc
-    def fetch(params = {})
+    def self.fetch(params = {})
       get("tasks", params)
     end
 
@@ -42,7 +42,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("task", {}, body)
     end
 
@@ -51,7 +51,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("task/#{id}")
     end
 
@@ -61,7 +61,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("task/#{id}", {}, body)
     end
 
@@ -70,7 +70,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def delete(id)
+    def self.delete(id)
       delete("task/#{id}")
     end
 
@@ -81,7 +81,7 @@ module Bloomerang
     # id                  integer
     # saveAsInteraction   boolean, True to create an interaction from the task; must be false if the task does not have a constituent
     # completedDate       string($date), default: Today, iso8601 format
-    def complete(id, params = {})
+    def self.complete(id, params = {})
       put("task/#{id}/complete", params)
     end
   end

data/lib/bloomerang/transaction.rb

@@ -45,7 +45,7 @@ module Bloomerang
     # maxAmount           number, Filters results based on the transaction's amount (inclusive).
     # orderBy         string, Available values : Id (default), CreatedDate, LastModifiedDate
     # orderDirection  string, Available values : Asc, Desc
-    def fetch(params = {})
+    def self.fetch(params = {})
       get("transactions", params)
     end
 
@@ -54,7 +54,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fiends
-    def create(body)
+    def self.create(body)
       post("transaction", {}, body)
     end
 
@@ -63,7 +63,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("transaction/#{id}")
     end
 
@@ -73,7 +73,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("transaction/#{id}", {}, body)
     end
 
@@ -82,7 +82,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def delete(id)
+    def self.delete(id)
       delete("transaction/#{id}")
     end
 
@@ -97,7 +97,7 @@ module Bloomerang
     # id                  array[integer], separated by pipes: "1|2|3"
     # orderBy             string, Available values : Id (default), CreatedDate, LastModifiedDate
     # orderDirection      string, Available values : Asc, Desc
-    def fetch_designations(params = {})
+    def self.fetch_designations(params = {})
       get("transactions/designations", params)
     end
 
@@ -106,7 +106,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get_designation(id)
+    def self.get_designation(id)
       get("transactions/designation/#{id}")
     end
   end

data/lib/bloomerang/tribute.rb

@@ -22,7 +22,7 @@ module Bloomerang
     # take            integer, default: 50, simple paging system
     # id              array[integer], separated by pipes: "1|2|3", Filters to tributes with the IDs in the list (pipe-separated)
     # isActive        boolean
-    def fetch(params = {})
+    def self.fetch(params = {})
       get("tributes", params)
     end
 
@@ -31,7 +31,7 @@ module Bloomerang
     #
     # Params:
     # body  JSON object, see API for fields
-    def create(body)
+    def self.create(body)
       post("tribute", {}, body)
     end
 
@@ -40,7 +40,7 @@ module Bloomerang
     #
     # Params:
     # id  integer
-    def get(id)
+    def self.show(id)
       get("tribute/#{id}")
     end
 
@@ -50,7 +50,7 @@ module Bloomerang
     # Params:
     # id    integer
     # body  JSON object, see API for fields
-    def update(id, body)
+    def self.update(id, body)
       put("tribute/#{id}", {}, body)
     end
 
@@ -59,7 +59,7 @@ module Bloomerang
     # skip            integer, default: 0,  simple paging system
     # take            integer, default: 50, simple paging system
     # search          string, The text to search (must be at least 3 characters)
-    def search_active(params = {})
+    def self.search_active(params = {})
       get("tributes/search", params)
     end
   end

data/lib/bloomerang/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bloomerang
-  VERSION = "0.2.2"
+  VERSION = "1.0.1".freeze
 end

data/lib/bloomerang.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "bloomerang/version"
-require_relative "bloomerang/base"
 require_relative "bloomerang/configuration"
+require_relative "bloomerang/base"
 
 require_relative "bloomerang/address"
 require_relative "bloomerang/appeal"
@@ -34,7 +34,11 @@ module Bloomerang
     @configuration ||= Configuration.new
   end
 
-  def self.configure(&block)
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure(&_block)
     yield(configuration)
   end
 end

data/lib/generators/bloomerang/templates/bloomerang_config.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "bloomerang"
+
 Bloomerang.configure do |config|
   ### Set your Bloomerang API key:
   # Generate your v2.0 API key from your Bloomerang user settings:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bloomerang_api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Chiperific
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-22 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md