kentaa-api 0.7.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd192c8023f46af9cea803f98b001a9ea269b7624ef185351aded186ff9e4cae
-  data.tar.gz: 729ee7893d096aa4262dcf9fa306e50f5ae9e8e4660b5bfb1cdc13bd23ad0d1a
+  metadata.gz: 7b4ba43909bec2ba160175c4324a916e5112b913a888e8f84001715a1d289814
+  data.tar.gz: 62cf01c563654ea233df6571525a0776d8ff41c27dcd74552824f6551ad8416b
 SHA512:
-  metadata.gz: f99a58f693ee130c32d81b89559eaf1b7e56454daef25b2954df048a905495c45dd019c4e348f666b51302f523345705a71de3b4698be8b6a037d224541af4fd
-  data.tar.gz: 6e59aedd98b789cc4e8a848b6ce8489bdf58e8428d29ef4cf805b452a914d56c3ba24d774cf7c263a8978bbe8f85c041f6ae728e25a1f61bf22893a3cb1935fd
+  metadata.gz: d87ea0e2e4f00c42804a971e8a58b879361ceb1edb5ecf1f9d1d1a73f6c328c73266323e0072be50adb1384654b229d545ec473cfe77ddac7bf3c292609c03fc
+  data.tar.gz: '00547798c1948a899b0d939897bd3fb49c1ca508772e43c4b03582512322af16588011e2bcd7b6a6d2b39d52cd2a082e4eb7418c0d2ca60e344e5932e9bcad33'

data/README.md

@@ -11,11 +11,15 @@ This gem provides a Ruby library for communicating with the [Kentaa API](https:/
 - [Installation](#installation)
 - [Usage](#usage)
   - [Actions](#actions)
+  - [Activities](#activities)
   - [Companies](#companies)
   - [Donation forms](#donation-forms)
   - [Donations](#donations)
   - [Manual donations](#manual-donations)
+  - [News](#news)
   - [Newsletter subscriptions](#newsletter-subscriptions)
+  - [Orders](#orders)
+  - [Payments](#payments)
   - [Performances](#performances)
     - [Photos](#performance-photos)
   - [Projects](#projects)
@@ -24,6 +28,7 @@ This gem provides a Ruby library for communicating with the [Kentaa API](https:/
   - [Sites](#sites)
   - [Teams](#teams)
   - [Users](#users)
+    - [Avatar](#user-avatar)
   - [Pagination](#pagination)
 - [Error handling](#error-handling)
 - [Development](#development)
@@ -102,6 +107,25 @@ action.title  # => "Foobar"
 See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#actions) and [Kentaa::Api::Resources::Action](lib/kentaa/api/resources/action.rb) for all available properties.
 
 
+### Activities
+
+```ruby
+# List Activities
+activities = client.activities
+
+activities.each do |activity|
+  activity.name  # => "Walking"
+end
+
+# Get Activity by ID
+activity = client.activities.get(1)
+
+activity.name  # => "Walking"
+```
+
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#activities) and [Kentaa::Api::Resources::Activity](lib/kentaa/api/resources/activity.rb) for all available properties.
+
+
 ### Companies
 
 ```ruby
@@ -154,7 +178,7 @@ See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#donation-
 donations = client.donations       # paginated
 donations = client.donations.all   # non-paginated
 
-donations.each do |donations|
+donations.each do |donation|
   donation.first_name  # => "John"
   donation.last_name  # => "Doe"
 end
@@ -177,7 +201,7 @@ See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#donations
 donations = client.manual_donations       # paginated
 donations = client.manual_donations.all   # non-paginated
 
-donations.each do |donations|
+donations.each do |donation|
   donation.first_name  # => "John"
   donation.last_name  # => "Doe"
 end
@@ -214,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
@@ -235,6 +279,41 @@ 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.
 
+### Orders
+
+```ruby
+# List Orders
+orders = client.orders       # paginated
+orders = client.orders.all   # non-paginated
+
+orders.each do |order|
+  order.first_name  # => "John"
+  order.last_name  # => "Doe"
+end
+
+# Get Order
+order = client.orders.get(1)
+
+order.name  # => "John Doe"
+order.total_amount # => BigDecimal("15.0")
+order.site  # => Kentaa::Api::Resources::Site
+```
+
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#orders) and [Kentaa::Api::Resources::Order](lib/kentaa/api/resources/order.rb) for all available properties.
+
+### Payments
+
+```ruby
+# Get Payment
+payment = client.payments.get(1)
+
+payment.total_amount  # => BigDecimal("95.0")
+payment.donations  # => Array[Kentaa::Api::Resources::Donation]
+payment.orders  # => Array[Kentaa::Api::Resources::Order]
+```
+
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#payments) and [Kentaa::Api::Resources::Payment](lib/kentaa/api/resources/payment.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.
@@ -287,13 +366,13 @@ photos = performance.photos       # paginated
 photos = performance.photos.all   # non-paginated
 
 photos.each do |photo|
-  photos.image_url  # => "https://d2a3ux41sjxpco.cloudfront.net/action_performance_photos/file/1/normal_8ce42aeb3bbb1b4964e621b42691f13d4dfa3f21.jpg"
+  photos.image_url  # => "https://cdn.kentaa.nl/action_performance_photos/file/1/normal_8ce42aeb3bbb1b4964e621b42691f13d4dfa3f21.jpg"
 end
 
 # Get Performance photo
 photo = performance.photos.get(1)
 
-photo.image_url  # => "https://d2a3ux41sjxpco.cloudfront.net/action_performance_photos/file/1/normal_8ce42aeb3bbb1b4964e621b42691f13d4dfa3f21.jpg"
+photo.image_url  # => "https://cdn.kentaa.nl/action_performance_photos/file/1/normal_8ce42aeb3bbb1b4964e621b42691f13d4dfa3f21.jpg"
 
 # Create a Performance photo
 photo = performance.photos.create(
@@ -301,7 +380,7 @@ photo = performance.photos.create(
   content_type: "image/jpeg"
 )
 
-photo.image_url  # => "https://d2a3ux41sjxpco.cloudfront.net/action_performance_photos/file/1/normal_8ce42aeb3bbb1b4964e621b42691f13d4dfa3f21.jpg"
+photo.image_url  # => "https://cdn.kentaa.nl/action_performance_photos/file/1/normal_8ce42aeb3bbb1b4964e621b42691f13d4dfa3f21.jpg"
 ```
 
 See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#performances-photos) and [Kentaa::Api::Resources::PerformancePhoto](lib/kentaa/api/resources/performance_photo.rb) for all available properties.
@@ -456,6 +535,28 @@ user.last_name  # => "Doe"
 
 See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#users) and [Kentaa::Api::Resources::User](lib/kentaa/api/resources/user.rb) for all available properties.
 
+#### User avatar
+
+```ruby
+# Get the User avatar
+avatar = user.avatar
+
+avatar.avatar_url  # => "https://cdn.kentaa.nl/avatars/avatar/1/thumb_8ce42aeb3bbb1b4964e621b42691f13d4dfa3f21.jpg"
+
+# Create / update the User avatar
+avatar = user.avatar.create(
+  io: File.open("photo.jpeg"),
+  content_type: "image/jpeg"
+)
+
+avatar.avatar_url  # => "https://cdn.kentaa.nl/avatars/avatar/1/thumb_8ce42aeb3bbb1b4964e621b42691f13d4dfa3f21.jpg"
+
+# Delete the User avatar
+user.avatar.delete
+```
+
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#user-avatars) and [Kentaa::Api::Resources::Avatar](lib/kentaa/api/resources/avatar.rb) for all available properties.
+
 ### Pagination
 
 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.

data/lib/kentaa/api/client.rb

@@ -11,6 +11,10 @@ module Kentaa
         Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Action, endpoint_path: '/actions'))
       end
 
+      def activities(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Activity, endpoint_path: '/activities'))
+      end
+
       def companies(options = {})
         Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Company, endpoint_path: '/companies'))
       end
@@ -31,6 +35,14 @@ module Kentaa
         Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::NewsletterSubscription, endpoint_path: '/newsletter-subscriptions'))
       end
 
+      def orders(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Order, endpoint_path: '/orders'))
+      end
+
+      def payments(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Payment, endpoint_path: '/payments'))
+      end
+
       def projects(options = {})
         Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Project, endpoint_path: '/projects'))
       end
@@ -43,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
@@ -145,7 +149,7 @@ module Kentaa
         end
 
         def activity
-          @activity ||= Kentaa::Api::Resources::Activity.new(data[:activity]) if data[:activity]
+          @activity ||= Kentaa::Api::Resources::Activity.new(config, data: data[:activity]) if data[:activity]
         end
 
         def previous_participations
@@ -161,11 +165,35 @@ module Kentaa
         end
 
         def registration_fee
-          @registration_fee ||= Kentaa::Api::Resources::RegistrationFee.new(data[:registration_fee])
+          @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])
+          @location ||= Kentaa::Api::Resources::Location.new(data[:location]) if data[:location]
         end
 
         def photos
@@ -242,6 +270,14 @@ 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
+
         def performances(options = {})
           @performances ||= Kentaa::Api::Resources::List.new(config, options.merge(resource_class: Kentaa::Api::Resources::Performance, endpoint_path: "/actions/#{id}/performances"))
         end

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

@@ -3,20 +3,40 @@
 module Kentaa
   module Api
     module Resources
-      class Activity
-        attr_reader :data
+      class Activity < Resource
+        def object_key
+          "Activity_#{id}"
+        end
+
+        def site
+          Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
+        end
 
-        def initialize(data)
-          @data = data
+        def public_id
+          data[:public_id]
         end
 
-        def id
-          data[:id]
+        def site_id
+          data[:site_id]
         end
 
         def name
           data[:name]
         end
+
+        def sign_up_limit
+          data[:sign_up_limit]
+        end
+
+        def sign_up_count
+          data[:sign_up_count]
+        end
+
+        private
+
+        def load_resource
+          request.get("#{endpoint_path}/#{id}", options)
+        end
       end
     end
   end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Kentaa
+  module Api
+    module Resources
+      class Avatar < Resource
+        def avatar_url
+          data[:avatar_url]
+        end
+
+        private
+
+        def load_resource
+          request.get("#{endpoint_path}/avatar", options)
+        end
+
+        def create_resource(attributes)
+          io = attributes.fetch(:io)
+          content_type = attributes.fetch(:content_type)
+
+          request.post("#{endpoint_path}/avatar", options, io, content_type: content_type)
+        end
+
+        def delete_resource
+          request.delete("#{endpoint_path}/avatar", options)
+        end
+      end
+    end
+  end
+end

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

@@ -83,6 +83,10 @@ module Kentaa
           data[:total_donations]
         end
 
+        def reserved_spots
+          data[:reserved_spots]
+        end
+
         def target_amount_achieved?
           data[:target_amount_achieved]
         end
@@ -166,7 +170,7 @@ module Kentaa
         end
 
         def activity
-          @activity ||= Kentaa::Api::Resources::Activity.new(data[:activity]) if data[:activity]
+          @activity ||= Kentaa::Api::Resources::Activity.new(config, data: data[:activity]) if data[:activity]
         end
 
         def contact
@@ -178,9 +182,15 @@ module Kentaa
         end
 
         def commerce_number
+          Kentaa::Api::Deprecation.warn('#commerce_number is deprecated.', caller)
+
           data[:commerce_number]
         end
 
+        def total_company_members
+          data[:total_company_members]
+        end
+
         def consents
           @consents ||= begin
             consents = []

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

@@ -23,7 +23,7 @@ module Kentaa
         end
 
         def amount
-          data[:amount]
+          BigDecimal(data[:amount])
         end
 
         def title
@@ -33,6 +33,14 @@ module Kentaa
         def description
           data[:description]
         end
+
+        def reservation_type
+          data[:reservation_type]
+        end
+
+        def reservation_limit
+          data[:reservation_limit]
+        end
       end
     end
   end

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

@@ -77,6 +77,10 @@ module Kentaa
         def gender
           data[:gender]
         end
+
+        def locale
+          data[:locale]
+        end
       end
     end
   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
@@ -126,9 +130,23 @@ module Kentaa
         end
 
         def amount
+          Kentaa::Api::Deprecation.warn('#amount is deprecated. Please use #donation_amount instead.', caller)
+
           BigDecimal(data[:amount])
         end
 
+        def donation_amount
+          BigDecimal(data[:donation_amount])
+        end
+
+        def company_registration_fee?
+          data[:company_registration_fee]
+        end
+
+        def company_registration_fee_amount
+          BigDecimal(data[:company_registration_fee_amount]) if data[:company_registration_fee_amount]
+        end
+
         def transaction_costs
           BigDecimal(data[:transaction_costs]) if data[:transaction_costs]
         end
@@ -260,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/logo.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Kentaa
+  module Api
+    module Resources
+      class Logo
+        attr_reader :data
+
+        def initialize(data)
+          @data = data
+        end
+
+        def url
+          data[:url]
+        end
+
+        def locale
+          data[:locale]
+        end
+      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