chmeetings 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 571af7b23e7b7cc9b57dd50b0830952c6bc022626b8fdffd18de96e8f0871683
+  data.tar.gz: 13f7aaad4c5af66c26492c0479439026e8edbbc6adb3070b037148ce0098731d
+SHA512:
+  metadata.gz: 4bbd3035a3dbed9f7b094d8cf61b7c33c509c0571148734f30d40edfe2eecca4aaf75eca0d9c1675b4a30d87592bc07a360b348bb9257eab95f66c63c352f78d
+  data.tar.gz: 2437e3e90b30eef91c985e763566681bbdaf131684c633c62bd1bcc3cda2a9ea132fb07fe59f6b29af852e83452811e1f94a904e3e9b00a6355e56f0ac88eeb3

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+3.3.5

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.1] - 2026-02-11
+
+### Added
+
+- A Client class with ApiKey header authentication
+- Methods to list, create, update, and delete people
+- Methods to list, create, get, update, and delete families
+- Methods to list, create, update, patch, and delete family members
+- Methods to list groups
+- Methods to list and create contributions
+- Methods to list pledges
+- Methods to list campaigns

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'dotenv', '~> 2.8.1'
+gem 'pry', '~> 0.14.2'
+gem 'puma', '~> 6.4'
+gem 'rake', '~> 12.3.3'
+gem 'reek', '~> 6.1'
+gem 'rspec', '~> 3.7'
+gem 'rubocop', '~> 1.57'
+gem 'sinatra', '~> 2.0'
+gem 'webmock', '~> 3.1'
+gem 'yard', '~> 0.9'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Taylor Brooks
+
+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,68 @@
+# Chmeetings
+
+A Ruby wrapper for the [ChMeetings API](https://api.chmeetings.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chmeetings'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chmeetings
+
+## Usage
+
+```ruby
+client = Chmeetings::Client.new(api_key: 'your_api_key')
+
+# People
+client.list_people
+client.create_person(first_name: 'John', last_name: 'Doe')
+client.update_person(person_id: 1, first_name: 'Jane')
+client.delete_person(person_id: 1)
+
+# Families
+client.list_families
+client.create_family(name: 'Doe Family')
+client.get_family(family_id: 1)
+client.update_family(family_id: 1, name: 'Smith Family')
+client.delete_family(family_id: 1)
+
+# Family Members
+client.list_family_members(family_id: 1)
+client.create_family_member(family_id: 1, person_id: 1)
+client.update_family_member(id: 1, family_id: 1, person_id: 2)
+client.patch_family_member(id: 1, role: 'Head')
+client.delete_family_member(id: 1)
+
+# Groups
+client.list_groups
+
+# Contributions
+client.list_contributions
+client.create_contribution(person_id: 1, amount: 100.0)
+
+# Pledges
+client.list_pledges
+
+# Campaigns
+client.list_campaigns
+```
+
+You can also configure the client using the `CHMEETINGS_API_KEY` environment variable:
+
+```ruby
+client = Chmeetings::Client.new
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :environment do
+  require 'dotenv'
+  Dotenv.load
+
+  $LOAD_PATH.unshift File.expand_path('lib', __dir__)
+  require 'chmeetings'
+end
+
+desc 'Launch a pry shell with libraries loaded'
+task pry: :environment do
+  options = {}
+  options[:logger] = Logger.new($stdout) unless ENV['CLIENT_LOGGER'].nil?
+  @client = Chmeetings::Client.new(**options) if ENV['CHMEETINGS_API_KEY']
+
+  require 'pry'
+  Pry.start
+end

data/chmeetings.gemspec

@@ -0,0 +1,25 @@
+require 'English'
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'chmeetings/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'chmeetings'
+  s.version       = Chmeetings::VERSION
+  s.authors       = ['Taylor Brooks']
+  s.homepage      = 'https://github.com/taylorbrooks/chmeetings'
+  s.summary       = 'A Ruby wrapper for the ChMeetings API'
+  s.description   = 'A Ruby wrapper for the ChMeetings API'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.executables   = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+
+  s.required_ruby_version = '>= 2.7'
+
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'faraday', '> 2.0'
+  s.add_runtime_dependency 'oj'
+
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/chmeetings/client/campaign.rb

@@ -0,0 +1,9 @@
+module Chmeetings
+  class Client
+    module Campaign
+      def list_campaigns(**options)
+        get('campaigns', options)
+      end
+    end
+  end
+end

data/lib/chmeetings/client/contribution.rb

@@ -0,0 +1,13 @@
+module Chmeetings
+  class Client
+    module Contribution
+      def list_contributions(**options)
+        get('contributions', options)
+      end
+
+      def create_contribution(**data)
+        post('contributions', data)
+      end
+    end
+  end
+end

data/lib/chmeetings/client/family.rb

@@ -0,0 +1,25 @@
+module Chmeetings
+  class Client
+    module Family
+      def list_families(**options)
+        get('families', options)
+      end
+
+      def create_family(**data)
+        post('families', data)
+      end
+
+      def get_family(**options)
+        get('families/show', options)
+      end
+
+      def update_family(**data)
+        put('families', data)
+      end
+
+      def delete_family(**data)
+        post('families/delete', data)
+      end
+    end
+  end
+end

data/lib/chmeetings/client/family_member.rb

@@ -0,0 +1,25 @@
+module Chmeetings
+  class Client
+    module FamilyMember
+      def list_family_members(**options)
+        get('family-members', options)
+      end
+
+      def create_family_member(**data)
+        post('family-members', data)
+      end
+
+      def update_family_member(**data)
+        put('family-members', data)
+      end
+
+      def patch_family_member(**data)
+        patch('family-members', data)
+      end
+
+      def delete_family_member(**data)
+        post('family-members/delete', data)
+      end
+    end
+  end
+end

data/lib/chmeetings/client/group.rb

@@ -0,0 +1,9 @@
+module Chmeetings
+  class Client
+    module Group
+      def list_groups(**options)
+        get('groups', options)
+      end
+    end
+  end
+end

data/lib/chmeetings/client/person.rb

@@ -0,0 +1,21 @@
+module Chmeetings
+  class Client
+    module Person
+      def list_people(**options)
+        get('people', options)
+      end
+
+      def create_person(**data)
+        post('people', data)
+      end
+
+      def update_person(**data)
+        put('people', data)
+      end
+
+      def delete_person(**data)
+        post('people/delete', data)
+      end
+    end
+  end
+end

data/lib/chmeetings/client/pledge.rb

@@ -0,0 +1,9 @@
+module Chmeetings
+  class Client
+    module Pledge
+      def list_pledges(**options)
+        get('pledges', options)
+      end
+    end
+  end
+end

data/lib/chmeetings/client.rb

@@ -0,0 +1,41 @@
+require 'faraday'
+
+Dir[File.expand_path('client/*.rb', __dir__)].sort.each { |f| require f }
+
+module Chmeetings
+  class Client
+    include Person
+    include Family
+    include FamilyMember
+    include Group
+    include Contribution
+    include Pledge
+    include Campaign
+
+    def initialize(**config)
+      @api_key = config[:api_key] || ENV.fetch('CHMEETINGS_API_KEY', nil)
+      @base_url = config[:base_url] || 'https://api.chmeetings.com/api/v1/'
+      @logger = config[:logger]
+      @adapter = config[:adapter] || Faraday.default_adapter
+    end
+
+    [:get, :post, :delete, :patch, :put].each do |http_method|
+      define_method(http_method) do |path, body = {}|
+        connection.public_send(http_method, path, body).body
+      end
+    end
+
+    private
+
+    def connection
+      Faraday.new(url: @base_url) do |conn|
+        conn.headers['ApiKey'] = @api_key
+        conn.request :json
+        conn.response :chmeetings_oj
+        conn.response :logger, @logger if @logger
+        conn.use Chmeetings::FaradayMiddleware::ChmeetingsErrorHandler
+        conn.adapter @adapter
+      end
+    end
+  end
+end

data/lib/chmeetings/error.rb

@@ -0,0 +1,58 @@
+require 'faraday'
+
+module Chmeetings # :nodoc: all
+  class Error < StandardError; end
+  class BadGateway < Error; end
+  class BadRequest < Error; end
+  class CloudflareError < Error; end
+  class Forbidden < Error; end
+  class GatewayTimeout < Error; end
+  class InternalServerError < Error; end
+  class NotFound < Error; end
+  class ServiceUnavailable < Error; end
+  class TooManyRequests < Error; end
+  class Unauthorized < Error; end
+
+  module FaradayMiddleware
+    class ChmeetingsErrorHandler < Faraday::Middleware
+      ERROR_STATUSES = (400..600).freeze
+
+      ##
+      # Throws an exception for responses with an HTTP error code.
+      def on_complete(env)
+        message = error_message(env)
+
+        case env[:status]
+        when 400
+          raise Chmeetings::BadRequest, message
+        when 401
+          raise Chmeetings::Unauthorized, message
+        when 403
+          raise Chmeetings::Forbidden, message
+        when 404
+          raise Chmeetings::NotFound, message
+        when 429
+          raise Chmeetings::TooManyRequests, message
+        when 500
+          raise Chmeetings::InternalServerError, message
+        when 502
+          raise Chmeetings::BadGateway, message
+        when 503
+          raise Chmeetings::ServiceUnavailable, message
+        when 504
+          raise Chmeetings::GatewayTimeout, message
+        when 520
+          raise Chmeetings::CloudflareError, message
+        when ERROR_STATUSES
+          raise Chmeetings::Error, message
+        end
+      end
+
+      private
+
+      def error_message(env)
+        "#{env[:status]}: #{env[:url]} #{env[:body]}"
+      end
+    end
+  end
+end

data/lib/chmeetings/parse_oj.rb

@@ -0,0 +1,26 @@
+require 'oj'
+
+module Chmeetings
+  module FaradayMiddleware
+    class ParseOj < Faraday::Middleware
+      ##
+      # Parses JSON responses.
+      def on_complete(env)
+        body = env[:body]
+        env[:body] = if empty_body?(body.strip)
+                       nil
+                     else
+                       Oj.load(body, mode: :compat)
+                     end
+      end
+
+      private
+
+      def empty_body?(body)
+        body.empty? && body == ''
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware(chmeetings_oj: Chmeetings::FaradayMiddleware::ParseOj)

data/lib/chmeetings/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Chmeetings
+  VERSION = '0.0.1'
+end

data/lib/chmeetings.rb

@@ -0,0 +1,7 @@
+require_relative 'chmeetings/version'
+require_relative 'chmeetings/error'
+require_relative 'chmeetings/parse_oj'
+require_relative 'chmeetings/client'
+
+module Chmeetings
+end

data/spec/chmeetings/client_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+RSpec.describe Chmeetings::Client do
+  let(:attrs) { { api_key: 'test_api_key' } }
+
+  subject(:client) { described_class.new(**attrs) }
+
+  shared_examples 'param request' do |verb|
+    let(:endpoint) { "#{verb}_test" }
+    let(:url) { "https://api.chmeetings.com/api/v1/#{endpoint}" }
+
+    before do
+      stub_request(:any, /_test/).to_return(body: response_body.to_json)
+    end
+
+    it 'requests at `path` argument' do
+      client.public_send(verb, endpoint)
+
+      expect(WebMock).to have_requested(verb, url)
+    end
+
+    it 'passes request parameters' do
+      client.public_send(verb, endpoint, request_params)
+
+      expect(WebMock).to have_requested(verb, url).with(query: request_params)
+    end
+
+    it 'returns parsed response body' do
+      expect(client.public_send(verb, endpoint)).to eq(response_body)
+    end
+  end
+
+  shared_examples 'body request' do |verb|
+    let(:body) { { 'test' => 123 } }
+    let(:endpoint) { "#{verb}_test" }
+    let(:url) { "https://api.chmeetings.com/api/v1/#{endpoint}" }
+
+    let(:do_request) { client.public_send(verb, endpoint, body) }
+
+    before do
+      stub_request(:any, /_test/).to_return(body: body.to_json)
+    end
+
+    it 'requests at `path` argument' do
+      do_request
+
+      expect(WebMock).to have_requested(verb, url)
+    end
+
+    it 'passes request body' do
+      do_request
+
+      expect(WebMock)
+        .to have_requested(verb, url)
+        .with(body: body)
+    end
+
+    it 'returns parsed response body' do
+      expect(do_request).to eq(body)
+    end
+  end
+
+  describe 'authentication' do
+    let(:path) { 'people' }
+    let(:url) { "https://api.chmeetings.com/api/v1/#{path}" }
+
+    it 'sends the ApiKey header' do
+      client.get(path)
+
+      expect(WebMock).to have_requested(:get, url)
+        .with(headers: { 'ApiKey' => 'test_api_key' })
+    end
+  end
+
+  describe 'env var authentication' do
+    let(:attrs) { {} }
+
+    before do
+      allow(ENV).to receive(:fetch).with('CHMEETINGS_API_KEY', nil).and_return('env_api_key')
+    end
+
+    it 'uses CHMEETINGS_API_KEY env var' do
+      client.get('people')
+
+      expect(WebMock).to have_requested(:get, 'https://api.chmeetings.com/api/v1/people')
+        .with(headers: { 'ApiKey' => 'env_api_key' })
+    end
+  end
+
+  describe '#get(path, options = {})' do
+    let(:request_params) { { 'test' => 123 } }
+    let(:response_body) { request_params }
+
+    include_examples 'param request', :get
+  end
+
+  describe '#delete(path, options = {})' do
+    let(:request_params) { { 'test' => 123 } }
+    let(:response_body) { {} }
+
+    include_examples 'param request', :delete
+  end
+
+  describe '#patch(path, options = {})' do
+    include_examples 'body request', :patch
+  end
+
+  describe '#post(path, options = {})' do
+    include_examples 'body request', :post
+  end
+
+  describe '#put(path, options = {})' do
+    include_examples 'body request', :put
+  end
+end

data/spec/chmeetings/error_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'rack/utils'
+
+CODES = Rack::Utils::HTTP_STATUS_CODES.keys.freeze
+
+RSpec.describe Chmeetings::Error do
+  let(:client) do
+    Chmeetings::Client.new(
+      base_url: 'http://some-chmeetings-uri.com/api/v1/',
+      api_key: 'test_api_key'
+    )
+  end
+
+  def stub(code, body)
+    stub_request(:any, /chmeetings/).to_return(status: code, body: body)
+  end
+
+  def expect_failure(code, body)
+    url = 'http://some-chmeetings-uri.com/api/v1/anything'
+
+    expect do
+      client.get('anything')
+    end.to raise_error(Chmeetings::Error, /#{code}: #{url} #{body}/)
+  end
+
+  def expect_success
+    expect { client.get('anything') }.to_not raise_error
+  end
+
+  context 'informational responses' do
+    CODES.grep(100..199).each do |code|
+      it "does not raise error for #{code}" do
+        stub(code, '{}')
+        expect_success
+      end
+    end
+  end
+
+  context 'success responses' do
+    CODES.grep(200..299).each do |code|
+      it "does not raise error for #{code}" do
+        stub(code, '{}')
+        expect_success
+      end
+    end
+  end
+
+  context 'redirection responses' do
+    CODES.grep(300..399).each do |code|
+      it "does not raise error for #{code}" do
+        stub(code, '')
+        expect_success
+      end
+    end
+  end
+
+  context 'client error responses' do
+    CODES.grep(400..499).each do |code|
+      it "raises exception for #{code}" do
+        stub(code, 'test client error')
+        expect_failure(code, 'test client error')
+      end
+    end
+  end
+
+  context 'server error responses' do
+    CODES.grep(500..599).each do |code|
+      it "raises exception for #{code}" do
+        stub(code, 'test client error')
+        expect_failure(code, 'test client error')
+      end
+    end
+  end
+
+  it 'raises TooManyRequests for 429' do
+    stub(429, 'rate limited')
+    expect { client.get('anything') }.to raise_error(Chmeetings::TooManyRequests)
+  end
+end