bloomerang_api 0.2.2

data/lib/bloomerang/tribute.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Bloomerang
+  ### Bloomerang::Tribute
+  ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes
+  # Id                    integer($int64)
+  # SortIndex             integer($int32)
+  # Note                  string
+  # TributeType           TributeType, string, Enum: [ InHonorOf, InMemoryOf ]
+  # NotificantAccountIds  array[integer], The IDs of all notificants (constituents) associated with this tribute
+  # Name                  string
+  # IsDefault             boolean, Is this the default?
+  # IsActive              boolean, Is this active?
+  class Tribute < Base
+    ### Fetch all tributes
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes/get_tributes
+    #
+    # Params:
+    # skip            integer, default: 0,  simple paging system
+    # 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 = {})
+      get("tributes", params)
+    end
+
+    ### Create a tribute
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes/post_tribute
+    #
+    # Params:
+    # body  JSON object, see API for fields
+    def create(body)
+      post("tribute", {}, body)
+    end
+
+    ### Fetch tribute by ID
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes/get_tribute__id_
+    #
+    # Params:
+    # id  integer
+    def get(id)
+      get("tribute/#{id}")
+    end
+
+    ### Update tribute
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes/put_tribute__id_
+    #
+    # Params:
+    # id    integer
+    # body  JSON object, see API for fields
+    def update(id, body)
+      put("tribute/#{id}", {}, body)
+    end
+
+    ### Search for active tributes
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes/get_tributes_search
+    # 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 = {})
+      get("tributes/search", params)
+    end
+  end
+end

data/lib/bloomerang/version.rb

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

data/lib/bloomerang.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "bloomerang/version"
+require_relative "bloomerang/base"
+require_relative "bloomerang/configuration"
+
+require_relative "bloomerang/address"
+require_relative "bloomerang/appeal"
+require_relative "bloomerang/campaign"
+require_relative "bloomerang/constituent"
+require_relative "bloomerang/custom_field"
+require_relative "bloomerang/email"
+require_relative "bloomerang/email_interest"
+require_relative "bloomerang/fund"
+require_relative "bloomerang/household"
+require_relative "bloomerang/interaction"
+require_relative "bloomerang/note"
+require_relative "bloomerang/phone"
+require_relative "bloomerang/pledge"
+# require_relative "bloomerang/processor"
+require_relative "bloomerang/refund"
+require_relative "bloomerang/relationship"
+require_relative "bloomerang/soft_credit"
+require_relative "bloomerang/task"
+require_relative "bloomerang/transaction"
+require_relative "bloomerang/tribute"
+# require_relative "bloomerang/user"
+# require_relative "bloomerang/wallet_item"
+
+module Bloomerang
+  class Error < StandardError; end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure(&block)
+    yield(configuration)
+  end
+end

data/lib/generators/bloomerang/USAGE

@@ -0,0 +1,3 @@
+To copy a Bloomerang initializer to your Rails app, which allows setting your API key, just run this command from a terminal:
+
+`rails generate bloomerang:initialize`

data/lib/generators/bloomerang/initializer/initializer_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Bloomerang
+  module Generators
+    class InitializerGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Copy Bloomerang initializer file"
+      def create_initializer_file
+        copy_file "bloomerang_config.rb", "config/initializers/bloomerang.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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

data/sig/bloomerang.rbs

@@ -0,0 +1,4 @@
+module Bloomerang
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: bloomerang_api
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Chiperific
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Unofficial Ruby API client for bloomerang.co, a donor management platform
+email:
+- chiperific@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/bloomerang.rb
+- lib/bloomerang/address.rb
+- lib/bloomerang/appeal.rb
+- lib/bloomerang/base.rb
+- lib/bloomerang/campaign.rb
+- lib/bloomerang/configuration.rb
+- lib/bloomerang/constituent.rb
+- lib/bloomerang/custom_field.rb
+- lib/bloomerang/email.rb
+- lib/bloomerang/email_interest.rb
+- lib/bloomerang/fund.rb
+- lib/bloomerang/household.rb
+- lib/bloomerang/interaction.rb
+- lib/bloomerang/note.rb
+- lib/bloomerang/phone.rb
+- lib/bloomerang/pledge.rb
+- lib/bloomerang/refund.rb
+- lib/bloomerang/relationship.rb
+- lib/bloomerang/soft_credit.rb
+- lib/bloomerang/task.rb
+- lib/bloomerang/transaction.rb
+- lib/bloomerang/tribute.rb
+- lib/bloomerang/version.rb
+- lib/generators/bloomerang/USAGE
+- lib/generators/bloomerang/initializer/initializer_generator.rb
+- lib/generators/bloomerang/templates/bloomerang_config.rb
+- sig/bloomerang.rbs
+homepage: https://github.com/chiperific/bloomerang
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/chiperific/bloomerang
+  source_code_uri: https://github.com/chiperific/bloomerang_api
+  changelog_uri: https://github.com/chiperific/bloomerang_api/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Unofficial Ruby API client for Bloomerang.co
+test_files: []