bloomerang_api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9903ebd5cdcf4b4391848bafdbb4d9efc27425747fdd9cae0708b8e27face094
-  data.tar.gz: 0306a903c3af7793c1d0818a825977d272589eae65147b47202ca1ae422c0771
+  metadata.gz: 1115ff6cbfd710e29125b2f1dffd2c3a0406f650cab18e5188d92f64384469cf
+  data.tar.gz: 2329d69106766e001d2bd55376a040f5a0ccda7a3e3117f7e33b519c85bc6200
 SHA512:
-  metadata.gz: 40ac8a464c0c2a25d7556c86702a8d6e7c023a62adaf49515f81fa3072f53b05805c7257b4e56b6f2c99e7470f96888b6b5596e979c5b8439ad2c54fb9040c08
-  data.tar.gz: 0dd925a4a930586421519f2fbf5cf939d2b20fd29756e7606cb8079309f06de5059578babd326bfcbce652569e85fbf60e32f1a70d17b56b53d7e1e4b1c6732d
+  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:
@@ -30,35 +30,34 @@ 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:
 
-- [dotenv](https://github.com/bkeepers/dotenv) strategy:
-    ```ruby
-    # ./.env
-    BLOOMERANG_API_KEY=myapikey
-    ```
+      ```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
-    ```
+  - [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:
 
@@ -90,28 +89,32 @@ Bloomerang.configure do |config|
 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!***
+
+: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:
 
-The standard structure of all endpoints is as follows:
+### Standard structure:
 
 - Reading records:
-    - `#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
+  - `#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:
 
@@ -121,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:
 
@@ -146,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`.
@@ -160,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/custom_field.rb

@@ -12,7 +12,7 @@ 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__
     #

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
     #

data/lib/bloomerang/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bloomerang_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  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