kentaa-api 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cfc728a7ee590a819c1e7c5e3fc83135ca7011a17c55a3dc02258396dcd4e20
-  data.tar.gz: 5c8dfd43935cf416e95e520c5864ae42520c3c3642dd959a99829921cc26015c
+  metadata.gz: 7b4ba43909bec2ba160175c4324a916e5112b913a888e8f84001715a1d289814
+  data.tar.gz: 62cf01c563654ea233df6571525a0776d8ff41c27dcd74552824f6551ad8416b
 SHA512:
-  metadata.gz: 5fe91636daba1aeb7e02427b001f7f8b115fe9df1174d4f1f83b74cd662b59d58c23f5207625b641d32b7297284d44a59246c1e8e3ad01871da449c2f8e8a7b5
-  data.tar.gz: e61fd63246ac0d11a6781bfa37929a3144378dc17bf27c8ddd4a0db60df3606c056bd601392c8da4511e5fd8f3697ea4683137bb54fdba51d725ec0ed944e302
+  metadata.gz: d87ea0e2e4f00c42804a971e8a58b879361ceb1edb5ecf1f9d1d1a73f6c328c73266323e0072be50adb1384654b229d545ec473cfe77ddac7bf3c292609c03fc
+  data.tar.gz: '00547798c1948a899b0d939897bd3fb49c1ca508772e43c4b03582512322af16588011e2bcd7b6a6d2b39d52cd2a082e4eb7418c0d2ca60e344e5932e9bcad33'

data/README.md

@@ -16,6 +16,7 @@ This gem provides a Ruby library for communicating with the [Kentaa API](https:/
   - [Donation forms](#donation-forms)
   - [Donations](#donations)
   - [Manual donations](#manual-donations)
+  - [News](#news)
   - [Newsletter subscriptions](#newsletter-subscriptions)
   - [Orders](#orders)
   - [Payments](#payments)
@@ -237,6 +238,26 @@ client.manual_donations.delete(1)
 
 See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#manual-donations) and [Kentaa::Api::Resources::ManualDonation](lib/kentaa/api/resources/manual_donation.rb) for all available properties.
 
+### News
+
+```ruby
+# List News
+news = client.news       # paginated
+news = client.news.all   # non-paginated
+
+news.each do |news_item|
+  news_item.title   # => "Lorem ipsum"
+  news_item.content  # => "<p>"Dolorum animi qui nihil iure dolore velit."</p>"
+end
+
+# Get News
+news_item = client.news.get(1)
+
+news_item.title    # => "Lorem ipsum"
+news_item.content  # => "<p>"Dolorum animi qui nihil iure dolore velit."</p>"
+```
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#news) and [Kentaa::Api::Resources::News](lib/kentaa/api/resources/news.rb) for all available properties.
+
 ### Newsletter subscriptions
 
 ```ruby

data/lib/kentaa/api/client.rb

@@ -55,6 +55,10 @@ module Kentaa
         Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Segment, endpoint_path: '/segments'))
       end
 
+      def news(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::News, endpoint_path: '/news'))
+      end
+
       def sites(options = {})
         Kentaa::Api::Resources::Sites.new(@config, options)
       end

data/lib/kentaa/api/resources/action.rb

@@ -32,6 +32,10 @@ module Kentaa
           Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
         end
 
+        def public_id
+          data[:public_id]
+        end
+
         def slug
           data[:slug]
         end
@@ -164,10 +168,30 @@ module Kentaa
           @registration_fee ||= Kentaa::Api::Resources::RegistrationFee.new(data[:registration_fee]) if data[:registration_fee]
         end
 
+        def has_target_amount?
+          data[:has_target_amount]
+        end
+
         def ticket
+          Kentaa::Api::Deprecation.warn('#ticket is deprecated. Please use #tickets instead.', caller)
+
           @ticket ||= Kentaa::Api::Resources::Ticket.new(data[:ticket]) if data[:ticket]
         end
 
+        def tickets
+          @tickets ||= begin
+            tickets = []
+
+            if data[:tickets]
+              data[:tickets].each do |ticket|
+                tickets << Kentaa::Api::Resources::Ticket.new(ticket)
+              end
+            end
+
+            tickets
+          end
+        end
+
         def location
           @location ||= Kentaa::Api::Resources::Location.new(data[:location]) if data[:location]
         end
@@ -246,6 +270,10 @@ module Kentaa
           @manual_donations ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::ManualDonation, endpoint_path: "/actions/#{id}/manual-donations")
         end
 
+        def news
+          @news ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::News, endpoint_path: "/actions/#{id}/news")
+        end
+
         def orders
           @orders ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::Order, endpoint_path: "/actions/#{id}/orders")
         end

data/lib/kentaa/api/resources/activity.rb

@@ -12,6 +12,10 @@ module Kentaa
           Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
         end
 
+        def public_id
+          data[:public_id]
+        end
+
         def site_id
           data[:site_id]
         end

data/lib/kentaa/api/resources/donation.rb

@@ -37,6 +37,10 @@ module Kentaa
           Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
         end
 
+        def public_id
+          data[:public_id]
+        end
+
         def site_id
           data[:site_id]
         end
@@ -274,6 +278,10 @@ module Kentaa
         def load_resource
           request.get("/donations/#{id}", options)
         end
+
+        def update_resource(attributes)
+          request.patch("/donations/#{id}", options, attributes)
+        end
       end
     end
   end

data/lib/kentaa/api/resources/location.rb

@@ -29,6 +29,14 @@ module Kentaa
         def longitude
           data[:longitude]
         end
+
+        def house_number
+          data[:house_number]
+        end
+
+        def country
+          data[:country]
+        end
       end
     end
   end

data/lib/kentaa/api/resources/manual_donation.rb

@@ -33,6 +33,10 @@ module Kentaa
           Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
         end
 
+        def public_id
+          data[:public_id]
+        end
+
         def site_id
           data[:site_id]
         end

data/lib/kentaa/api/resources/news.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Kentaa
+  module Api
+    module Resources
+      class News < Resource
+        def object_key
+          "News_#{id}"
+        end
+
+        def public_id
+          data[:public_id]
+        end
+
+        def site
+          Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
+        end
+
+        def title
+          data[:title]
+        end
+
+        def content
+          data[:content]
+        end
+
+        def labels
+          data[:labels]
+        end
+
+        def publish_state
+          data[:publish_state]
+        end
+
+        def publish_at
+          Time.parse(data[:publish_at]) if data[:publish_at]
+        end
+
+        def photos
+          @photos ||= begin
+            photos = []
+
+            if data[:photos]
+              data[:photos].each do |photo|
+                photos << Kentaa::Api::Resources::Photo.new(photo)
+              end
+            end
+
+            photos
+          end
+        end
+
+        def videos
+          @videos ||= begin
+            videos = []
+
+            if data[:videos]
+              data[:videos].each do |video|
+                videos << Kentaa::Api::Resources::Video.new(video)
+              end
+            end
+
+            videos
+          end
+        end
+
+        private
+
+        def load_resource
+          request.get("/news/#{id}", options)
+        end
+      end
+    end
+  end
+end

data/lib/kentaa/api/resources/order.rb

@@ -19,10 +19,22 @@ module Kentaa
           Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
         end
 
+        def public_id
+          data[:public_id]
+        end
+
         def site_id
           data[:site_id]
         end
 
+        def segment_id
+          data[:segment_id]
+        end
+
+        def project_id
+          data[:project_id]
+        end
+
         def action_id
           data[:action_id]
         end

data/lib/kentaa/api/resources/project.rb

@@ -23,6 +23,10 @@ module Kentaa
           Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
         end
 
+        def public_id
+          data[:public_id]
+        end
+
         def slug
           data[:slug]
         end
@@ -63,6 +67,14 @@ module Kentaa
           data[:visible]
         end
 
+        def publishable?
+          data[:publishable]
+        end
+
+        def published_at
+          Time.parse(data[:published_at]) if data[:published_at]
+        end
+
         def countable?
           data[:countable]
         end
@@ -87,6 +99,10 @@ module Kentaa
           data[:donate_url]
         end
 
+        def has_target_amount?
+          data[:has_target_amount]
+        end
+
         def location
           @location ||= Kentaa::Api::Resources::Location.new(data[:location]) if data[:location]
         end
@@ -185,6 +201,26 @@ module Kentaa
           @activities ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::Activity, endpoint_path: "/projects/#{id}/activities")
         end
 
+        def news
+          @news ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::News, endpoint_path: "/projects/#{id}/news")
+        end
+
+        def orders
+          @orders ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::Order, endpoint_path: "/projects/#{id}/orders")
+        end
+
+        def publish
+          request.post("/projects/#{id}/publish")
+        end
+
+        def hide
+          request.post("/projects/#{id}/hide")
+        end
+
+        def show
+          request.post("/projects/#{id}/show")
+        end
+
         private
 
         def load_resource

data/lib/kentaa/api/resources/question.rb

@@ -29,6 +29,10 @@ module Kentaa
         def answer
           data[:answer]
         end
+
+        def external_reference
+          data[:external_reference]
+        end
       end
     end
   end

data/lib/kentaa/api/resources/security_activity.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Kentaa
+  module Api
+    module Resources
+      class SecurityActivity
+        attr_reader :data
+
+        def initialize(data)
+          @data = data
+        end
+
+        def last_login_at
+          Time.parse(data[:last_login_at]) if data[:last_login_at]
+        end
+
+        def reset_password_email_sent_at
+          Time.parse(data[:reset_password_email_sent_at]) if data[:reset_password_email_sent_at]
+        end
+
+        def last_password_reset_at
+          Time.parse(data[:last_password_reset_at]) if data[:last_password_reset_at]
+        end
+      end
+    end
+  end
+end

data/lib/kentaa/api/resources/segment.rb

@@ -19,6 +19,10 @@ module Kentaa
           Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
         end
 
+        def public_id
+          data[:public_id]
+        end
+
         def site_id
           data[:site_id]
         end
@@ -109,6 +113,14 @@ module Kentaa
           @activities ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::Activity, endpoint_path: "/segments/#{id}/activities")
         end
 
+        def news
+          @news ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::News, endpoint_path: "/segments/#{id}/news")
+        end
+
+        def orders
+          @orders ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::Order, endpoint_path: "/segments/#{id}/orders")
+        end
+
         private
 
         def load_resource

data/lib/kentaa/api/resources/site.rb

@@ -11,6 +11,10 @@ module Kentaa
           "Site_#{id}"
         end
 
+        def public_id
+          data[:public_id]
+        end
+
         def host
           data[:host]
         end

data/lib/kentaa/api/resources/team.rb

@@ -25,6 +25,10 @@ module Kentaa
           Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
         end
 
+        def public_id
+          data[:public_id]
+        end
+
         def slug
           data[:slug]
         end
@@ -173,6 +177,10 @@ module Kentaa
           @manual_donations ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::ManualDonation, endpoint_path: "/teams/#{id}/manual-donations")
         end
 
+        def news
+          @news ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::News, endpoint_path: "/teams/#{id}/news")
+        end
+
         private
 
         def load_resource

data/lib/kentaa/api/resources/user.rb

@@ -14,6 +14,10 @@ module Kentaa
           Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
         end
 
+        def public_id
+          data[:public_id]
+        end
+
         def site_id
           data[:site_id]
         end
@@ -90,6 +94,10 @@ module Kentaa
           data[:locale]
         end
 
+        def security_activity
+          @security_activity ||= Kentaa::Api::Resources::SecurityActivity.new(data[:security_activity]) if data[:security_activity]
+        end
+
         def consent
           Kentaa::Api::Deprecation.warn('#consent is deprecated. Please use #consents instead.', caller)
 
@@ -118,6 +126,10 @@ module Kentaa
           @avatar ||= Kentaa::Api::Resources::Avatar.new(config, options: options.merge(endpoint_path: "/users/#{id}"))
         end
 
+        def reset_password
+          request.post("/users/#{id}/reset-password")
+        end
+
         private
 
         def load_resource

data/lib/kentaa/api/response.rb

@@ -5,6 +5,8 @@ require 'json'
 module Kentaa
   module Api
     class Response
+      SUCCESS_CODES = [200, 201, 204].freeze
+
       attr_reader :response, :body
 
       def initialize(response)
@@ -13,7 +15,7 @@ module Kentaa
       end
 
       def success?
-        (http_code == 200 || http_code == 201 || http_code == 204) && !message
+        SUCCESS_CODES.include?(http_code) && !message
       end
 
       def error?

data/lib/kentaa/api/util.rb

@@ -1,16 +1,15 @@
 # frozen_string_literal: true
 
+require 'dry/inflector'
+
 module Kentaa
   module Api
     module Util
       module_function
 
       def pluralize(string)
-        if string[-1] == 'y'
-          "#{string.chop}ies"
-        else
-          "#{string}s"
-        end
+        inflector = Dry::Inflector.new
+        inflector.pluralize(string)
       end
     end
   end

data/lib/kentaa/api/version.rb

@@ -2,6 +2,6 @@
 
 module Kentaa
   module Api
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
   end
 end

data/lib/kentaa/api.rb

@@ -20,6 +20,7 @@ require_relative 'api/resources/donation'
 require_relative 'api/resources/location'
 require_relative 'api/resources/logo'
 require_relative 'api/resources/manual_donation'
+require_relative 'api/resources/news'
 require_relative 'api/resources/newsletter_subscription'
 require_relative 'api/resources/order'
 require_relative 'api/resources/order_item'
@@ -29,10 +30,11 @@ require_relative 'api/resources/performance_photo'
 require_relative 'api/resources/photo'
 require_relative 'api/resources/product'
 require_relative 'api/resources/project'
+require_relative 'api/resources/question'
 require_relative 'api/resources/recurring_donor'
 require_relative 'api/resources/registration_fee'
 require_relative 'api/resources/reward'
-require_relative 'api/resources/question'
+require_relative 'api/resources/security_activity'
 require_relative 'api/resources/segment'
 require_relative 'api/resources/site'
 require_relative 'api/resources/sites'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kentaa-api
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Kentaa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-11 00:00:00.000000000 Z
+date: 2025-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -127,6 +141,7 @@ files:
 - lib/kentaa/api/resources/location.rb
 - lib/kentaa/api/resources/logo.rb
 - lib/kentaa/api/resources/manual_donation.rb
+- lib/kentaa/api/resources/news.rb
 - lib/kentaa/api/resources/newsletter_subscription.rb
 - lib/kentaa/api/resources/order.rb
 - lib/kentaa/api/resources/order_item.rb
@@ -141,6 +156,7 @@ files:
 - lib/kentaa/api/resources/registration_fee.rb
 - lib/kentaa/api/resources/resource.rb
 - lib/kentaa/api/resources/reward.rb
+- lib/kentaa/api/resources/security_activity.rb
 - lib/kentaa/api/resources/segment.rb
 - lib/kentaa/api/resources/site.rb
 - lib/kentaa/api/resources/sites.rb
@@ -173,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Ruby library for communicating with the Kentaa API