kentaa-api 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23a4a4487aa472a316b501c6828a794dc7adb49a401142f81380e876db16e38b
-  data.tar.gz: 64237a805e5dfb9631acffeede977b9db625c1768233276d21b573f02926c6c6
+  metadata.gz: da9bb3b58fe4533c642cd80ca677b29aff5e779aa1335ecbda2ba5c502133487
+  data.tar.gz: 3ad011c17955567de318e2e1c8f959afd3ea3f6aad8d66381f0d2c48abd7c6e5
 SHA512:
-  metadata.gz: b6efd4d9df769a58d90865c636782cc16ee3c84d2eebf66387cbd9a9758dbc2d534ad3fd33a975f6481b6ded97448a5249449427f619de9c033bc10e201100f2
-  data.tar.gz: a773cebe9d89d3d230d34e37f47e35af40a28815070bf8d5212f5fee83c208663ce0fb8664a211c0b523a091ef8df5d453ca7d17c4616fd967b2486c3be5dc9e
+  metadata.gz: 2b00e2f9db7313a96e4d205337ae9c2a9d9872d5ff97865246a6b1b391ae47cd615c2e736eac0ea5a6e890cb553bbfa66d5ddf31b83a60dc6d48f580912a430d
+  data.tar.gz: 50f33d783a2055d71bdbf9bdc446be064bb109b71e04f6736e9dfb29b0dc670fe42001b89c218904405a218b3700c3d030fdd1c1292658b958ba77e62b9dafc3

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -11,6 +11,7 @@ AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
   Exclude:
+    - 'tmp/**/*'
     - 'vendor/**/*'
 
 Layout/LineLength:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kentaa-api (0.5.0)
+    kentaa-api (0.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -11,7 +11,7 @@ GEM
     ast (2.4.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     hashdiff (0.3.7)
     parallel (1.20.1)
     parser (3.0.0.0)
@@ -20,20 +20,20 @@ GEM
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     rubocop (1.12.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)

data/README.md

@@ -1,7 +1,7 @@
 # Kentaa API
 
 [![Gem Version](https://badge.fury.io/rb/kentaa-api.svg)](https://badge.fury.io/rb/kentaa-api)
-[![Build Status](https://travis-ci.org/KentaaNL/kentaa-api.svg?branch=master)](https://travis-ci.org/KentaaNL/kentaa-api)
+[![Build Status](https://github.com/KentaaNL/kentaa-api/actions/workflows/test.yml/badge.svg)](https://github.com/KentaaNL/kentaa-api/actions)
 [![Code Climate](https://codeclimate.com/github/KentaaNL/kentaa-api/badges/gpa.svg)](https://codeclimate.com/github/KentaaNL/kentaa-api)
 
 This gem provides a Ruby library for communicating with the [Kentaa API](https://developer.kentaa.nl/kentaa-api/).
@@ -15,6 +15,7 @@ This gem provides a Ruby library for communicating with the [Kentaa API](https:/
   - [Donations](#donations)
   - [Manual donations](#manual-donations)
   - [Newsletter subscriptions](#newsletter-subscriptions)
+  - [Performances](#performances)
   - [Projects](#projects)
   - [Recurring donors](#recurring-donors)
   - [Segments](#segments)
@@ -45,26 +46,25 @@ Or install it yourself as:
 
 ## Usage
 
-Create a Kentaa API configuration and client using your API key:
+Create a Kentaa API client using your API key:
 
 ```ruby
 require 'kentaa/api'
 
-config = Kentaa::Api::Config.new('your_api_key')
-client = Kentaa::Api::Client.new(config)
+client = Kentaa::Api::Client.new(api_key: 'your_api_key')
 ```
 
-The configuration is created for the production environment by default. If you want to use the testing environment, then add `test: true`:
+The client is created for the production environment by default. If you want to use the testing environment, then add `test: true`:
 
 ```ruby
-config = Kentaa::Api::Config.new('your_api_key', test: true)
+client = Kentaa::Api::Client.new(api_key: 'your_api_key', test: true)
 ```
 
 ### Actions
 
 ```ruby
 # List Actions
-actions = client.actions.list  # paginated
+actions = client.actions       # paginated
 actions = client.actions.all   # non-paginated
 
 actions.each do |action|
@@ -103,7 +103,7 @@ See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#actions)
 
 ```ruby
 # List Donation forms
-donation_forms = client.donation_forms.list  # paginated
+donation_forms = client.donation_forms       # paginated
 donation_forms = client.donation_forms.all   # non-paginated
 
 donation_forms.each do |form|
@@ -126,7 +126,7 @@ See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#donation-
 
 ```ruby
 # List Donations
-donations = client.donations.list  # paginated
+donations = client.donations       # paginated
 donations = client.donations.all   # non-paginated
 
 donations.each do |donations|
@@ -149,7 +149,7 @@ See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#donations
 
 ```ruby
 # List Manual donations
-donations = client.manual_donations.list  # paginated
+donations = client.manual_donations       # paginated
 donations = client.manual_donations.all   # non-paginated
 
 donations.each do |donations|
@@ -193,7 +193,7 @@ See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#manual-do
 
 ```ruby
 # List Newsletter subscriptions
-newsletter_subscriptions = client.newsletter_subscriptions.list  # paginated
+newsletter_subscriptions = client.newsletter_subscriptions       # paginated
 newsletter_subscriptions = client.newsletter_subscriptions.all   # non-paginated
 
 newsletter_subscriptions.each do |subscription|
@@ -210,11 +210,55 @@ subscription.subscription_url  # => "https://demo1.kentaa.nl"
 
 See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#newsletter-subscriptions) and [Kentaa::Api::Resources::NewsletterSubscription](lib/kentaa/api/resources/newsletter_subscription.rb) for all available properties.
 
+### Performances
+
+Performances are available on an [Kentaa::Api::Resources::Action](lib/kentaa/api/resources/action.rb), so you first need to retrieve an Action.
+
+```ruby
+action = client.actions.get(1)
+
+# List Performances
+performances = action.performances       # paginated
+performances = action.performances.all   # non-paginated
+
+performances.each do |performance|
+  performance.title  # => "First tour"
+  performance.distance  # => BigDecimal("65.25")
+end
+
+# Get Performance
+donation = action.performances.get(1)
+
+performance.title  # => "First tour"
+performance.distance  # => BigDecimal("65.25")
+
+# Create a Performance
+performance = action.performances.create(
+  title: "First tour",
+  performance_type: "biking",
+  performance_at: Time.now,
+  distance: "65.25"
+)
+
+performance.title  # => "First tour"
+performance.distance  # => BigDecimal("65.25")
+
+# Update a Performance
+performance = action.performance.update(1, title: "Big tour")
+
+performance.title  # => "Big tour"
+
+# Delete a Performance
+action.performance.delete(1)
+```
+
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#performances) and [Kentaa::Api::Resources::Performance](lib/kentaa/api/resources/performance.rb) for all available properties.
+
 ### Projects
 
 ```ruby
 # List Projects
-projects = client.projects.list  # paginated
+projects = client.projects       # paginated
 projects = client.projects.all   # non-paginated
 
 projects.each do |project|
@@ -237,7 +281,7 @@ See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#projects)
 
 ```ruby
 # List Recurring donors
-recurring_donors = client.recurring_donors.list  # paginated
+recurring_donors = client.recurring_donors       # paginated
 recurring_donors = client.recurring_donors.all   # non-paginated
 
 recurring_donors.each do |recurring_donor|
@@ -260,7 +304,7 @@ See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#recurring
 
 ```ruby
 # List Segments
-segments = client.segments.list  # paginated
+segments = client.segments       # paginated
 segments = client.segments.all   # non-paginated
 
 segments.each do |segment|
@@ -298,7 +342,7 @@ See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#sites) an
 
 ```ruby
 # List Teams
-teams = client.teams.list  # paginated
+teams = client.teams       # paginated
 teams = client.teams.all   # non-paginated
 
 teams.each do |team|
@@ -321,7 +365,7 @@ See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#teams) an
 
 ```ruby
 # List Users
-users = client.users.list  # paginated
+users = client.users       # paginated
 users = client.users.all   # non-paginated
 
 users.each do |user|
@@ -362,11 +406,10 @@ See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#users) an
 
 ### Pagination
 
-The `list` method on the endpoint returns an [Enumerable](https://ruby-doc.org/core/Enumerable.html) object with paginated results.
-Default page size is 25, but you can can customize this by setting the `per_page` parameter:
+All List actions return paginated results in an [Enumerable](https://ruby-doc.org/core/Enumerable.html) object. The default page size is 25, but you can can customize this by setting the `per_page` parameter.
 
 ```ruby
-actions = client.actions.list(per_page: 100)
+actions = client.actions(per_page: 100)
 
 actions.each do |action|
   action.title  # => "Lorem ipsum"
@@ -374,10 +417,10 @@ actions.each do |action|
 end
 ```
 
-You can iterate through the pages using the `.next` method and checking the result:
+You can iterate through the pages using the `.next` method and checking the result. For example:
 
 ```ruby
-actions = client.actions.list
+actions = client.actions
 
 loop do  
   actions.each do |action|

data/lib/kentaa/api.rb

@@ -1,52 +1,32 @@
 # frozen_string_literal: true
 
-require_relative "api/clients/base"
-require_relative "api/clients/actions"
-require_relative "api/clients/donation_forms"
-require_relative "api/clients/donations"
-require_relative "api/clients/manual_donations"
-require_relative "api/clients/newsletter_subscriptions"
-require_relative "api/clients/projects"
-require_relative "api/clients/recurring_donors"
-require_relative "api/clients/segments"
-require_relative "api/clients/sites"
-require_relative "api/clients/teams"
-require_relative "api/clients/users"
-
 require_relative "api/resources/base"
 require_relative "api/resources/error"
 require_relative "api/resources/list"
 require_relative "api/resources/resource"
 
 require_relative "api/resources/action"
-require_relative "api/resources/actions"
 require_relative "api/resources/activity"
 require_relative "api/resources/address"
 require_relative "api/resources/banner"
 require_relative "api/resources/consent"
 require_relative "api/resources/contact"
 require_relative "api/resources/donation_form"
-require_relative "api/resources/donation_forms"
 require_relative "api/resources/donation"
-require_relative "api/resources/donations"
 require_relative "api/resources/location"
 require_relative "api/resources/manual_donation"
-require_relative "api/resources/manual_donations"
 require_relative "api/resources/newsletter_subscription"
-require_relative "api/resources/newsletter_subscriptions"
+require_relative "api/resources/performance"
 require_relative "api/resources/photo"
 require_relative "api/resources/project"
-require_relative "api/resources/projects"
-require_relative "api/resources/question"
 require_relative "api/resources/recurring_donor"
-require_relative "api/resources/recurring_donors"
 require_relative "api/resources/registration_fee"
 require_relative "api/resources/reward"
+require_relative "api/resources/question"
 require_relative "api/resources/segment"
-require_relative "api/resources/segments"
 require_relative "api/resources/site"
+require_relative "api/resources/sites"
 require_relative "api/resources/team"
-require_relative "api/resources/teams"
 require_relative "api/resources/user"
 require_relative "api/resources/users"
 require_relative "api/resources/video"
@@ -54,8 +34,8 @@ require_relative "api/resources/video"
 require_relative "api/client"
 require_relative "api/config"
 require_relative "api/exception"
-require_relative "api/finder"
 require_relative "api/request"
 require_relative "api/response"
+require_relative "api/util"
 
 require_relative "api/version"

data/lib/kentaa/api/client.rb

@@ -3,52 +3,52 @@
 module Kentaa
   module Api
     class Client
-      def initialize(config)
-        @config = config
+      def initialize(options = {})
+        @config = Kentaa::Api::Config.new(options)
       end
 
-      def actions
-        Kentaa::Api::Clients::Actions.new(@config)
+      def actions(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Action, endpoint_path: "/actions"))
       end
 
-      def donation_forms
-        Kentaa::Api::Clients::DonationForms.new(@config)
+      def donations(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Donation, endpoint_path: "/donations"))
       end
 
-      def donations
-        Kentaa::Api::Clients::Donations.new(@config)
+      def donation_forms(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::DonationForm, endpoint_path: "/donation-forms"))
       end
 
-      def manual_donations
-        Kentaa::Api::Clients::ManualDonations.new(@config)
+      def manual_donations(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::ManualDonation, endpoint_path: "/manual-donations"))
       end
 
-      def newsletter_subscriptions
-        Kentaa::Api::Clients::NewsletterSubscriptions.new(@config)
+      def newsletter_subscriptions(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::NewsletterSubscription, endpoint_path: "/newsletter-subscriptions"))
       end
 
-      def projects
-        Kentaa::Api::Clients::Projects.new(@config)
+      def projects(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Project, endpoint_path: "/projects"))
       end
 
-      def recurring_donors
-        Kentaa::Api::Clients::RecurringDonors.new(@config)
+      def recurring_donors(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::RecurringDonor, endpoint_path: "/recurring-donors"))
       end
 
-      def segments
-        Kentaa::Api::Clients::Segments.new(@config)
+      def segments(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Segment, endpoint_path: "/segments"))
       end
 
-      def sites
-        Kentaa::Api::Clients::Sites.new(@config)
+      def sites(options = {})
+        Kentaa::Api::Resources::Sites.new(@config, options)
       end
 
-      def teams
-        Kentaa::Api::Clients::Teams.new(@config)
+      def teams(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Team, endpoint_path: "/teams"))
       end
 
-      def users
-        Kentaa::Api::Clients::Users.new(@config)
+      def users(options = {})
+        Kentaa::Api::Resources::Users.new(@config, options)
       end
     end
   end

data/lib/kentaa/api/config.rb

@@ -7,13 +7,16 @@ module Kentaa
       TEST_URL = "https://api.kentaa.staatklaar.nu/v1"
       DEV_URL  = "http://api.lvh.me:3000/v1"
 
-      attr_accessor :api_key, :options
+      attr_accessor :options
 
-      def initialize(api_key, options = {})
-        @api_key = api_key
+      def initialize(options = {})
         @options = options
       end
 
+      def api_key
+        options.fetch(:api_key)
+      end
+
       def api_url
         case environment
         when :test