kentaa-api 0.4.0 → 0.7.0

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

@@ -1,25 +1,98 @@
 # frozen_string_literal: true
 
+require 'time'
+
 module Kentaa
   module Api
     module Resources
       class Consent
+        STATUS_GRANTED = 'granted'
+        STATUS_REVOKED = 'revoked'
+
+        TYPE_TERMS_CONDITIONS = 'terms_conditions'
+        TYPE_PROCESSING_PERSONAL_DATA = 'processing_personal_data'
+        TYPE_PROCESSING_PERSONAL_SENSITIVE_DATA = 'processing_personal_sensitive_data'
+        TYPE_NEWSLETTER_SUBSCRIPTION = 'newsletter_subscription'
+        TYPE_NEWS_ITEM_SUBSCRIPTION = 'news_item_subscription'
+        TYPE_CONTACT_PHONE = 'contact_phone'
+        TYPE_CONTACT_PHONE_COMMERCIAL = 'contact_phone_commercial'
+
         attr_reader :data
 
         def initialize(data)
           @data = data
         end
 
-        def url
-          data[:url]
+        def consent_type
+          data[:consent_type]
+        end
+
+        def terms_conditions?
+          consent_type == TYPE_TERMS_CONDITIONS
+        end
+
+        def processing_personal_data?
+          consent_type == TYPE_PROCESSING_PERSONAL_DATA
+        end
+
+        def processing_personal_sensitive_data?
+          consent_type == TYPE_PROCESSING_PERSONAL_SENSITIVE_DATA
+        end
+
+        def newsletter_subscription?
+          consent_type == TYPE_NEWSLETTER_SUBSCRIPTION
+        end
+
+        def news_item_subscription?
+          consent_type == TYPE_NEWS_ITEM_SUBSCRIPTION
+        end
+
+        def contact_phone?
+          consent_type == TYPE_CONTACT_PHONE
+        end
+
+        def contact_phone_commercial?
+          consent_type == TYPE_CONTACT_PHONE_COMMERCIAL
+        end
+
+        def consent_status
+          data[:consent_status]
+        end
+
+        def granted?
+          consent_status == STATUS_GRANTED
+        end
+
+        def revoked?
+          consent_status == STATUS_REVOKED
+        end
+
+        def granted_at
+          Time.parse(data[:granted_at])
+        end
+
+        def revoked_at
+          Time.parse(data[:revoked_at]) if data[:revoked_at]
+        end
+
+        def consent_text
+          data[:consent_text]
         end
 
         def text
-          data[:text]
+          data[:text] || data[:consent_text]
+        end
+
+        def url
+          data[:url]
         end
 
         def version
-          data[:version]
+          data[:version] || data[:terms_conditions_version]
+        end
+
+        def terms_conditions_version
+          data[:terms_conditions_version]
         end
       end
     end

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

@@ -23,7 +23,7 @@ module Kentaa
         end
 
         def name
-          [first_name, infix, last_name].reject { |s| s.to_s.empty? }.join(" ")
+          [first_name, infix, last_name].reject { |s| s.to_s.empty? }.join(' ')
         end
 
         def email
@@ -71,7 +71,7 @@ module Kentaa
         end
 
         def birthday
-          Time.parse(data[:birthday]) if data[:birthday]
+          Date.parse(data[:birthday]) if data[:birthday]
         end
 
         def gender

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

@@ -13,22 +13,36 @@ module Kentaa
 
         def entity
           if action_id
-            Kentaa::Api::Resources::Action.new(config, id: action_id)
+            Kentaa::Api::Resources::Action.new(config, id: action_id, options: options)
           elsif team_id
-            Kentaa::Api::Resources::Team.new(config, id: team_id)
+            Kentaa::Api::Resources::Team.new(config, id: team_id, options: options)
           elsif project_id
-            Kentaa::Api::Resources::Project.new(config, id: project_id)
+            Kentaa::Api::Resources::Project.new(config, id: project_id, options: options)
           elsif segment_id
-            Kentaa::Api::Resources::Segment.new(config, id: segment_id)
+            Kentaa::Api::Resources::Segment.new(config, id: segment_id, options: options)
+          elsif donation_form_id
+            Kentaa::Api::Resources::DonationForm.new(config, id: donation_form_id, options: options)
           else
-            Kentaa::Api::Resources::Site.new(config, id: site_id)
+            Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
           end
         end
 
+        def recurring_donor
+          Kentaa::Api::Resources::RecurringDonor.new(config, id: recurring_donor_id, options: options) if recurring_donor_id
+        end
+
+        def site
+          Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
+        end
+
         def site_id
           data[:site_id]
         end
 
+        def donation_form_id
+          data[:donation_form_id]
+        end
+
         def segment_id
           data[:segment_id]
         end
@@ -45,6 +59,10 @@ module Kentaa
           data[:action_id]
         end
 
+        def recurring_donor_id
+          data[:recurring_donor_id]
+        end
+
         def first_name
           data[:first_name]
         end
@@ -58,7 +76,7 @@ module Kentaa
         end
 
         def name
-          [first_name, infix, last_name].reject { |s| s.to_s.empty? }.join(" ")
+          [first_name, infix, last_name].reject { |s| s.to_s.empty? }.join(' ')
         end
 
         def company
@@ -89,6 +107,10 @@ module Kentaa
           data[:locale]
         end
 
+        def frequency_type
+          data[:frequency_type]
+        end
+
         def currency
           data[:currency]
         end
@@ -192,7 +214,7 @@ module Kentaa
         end
 
         def birthday
-          Time.parse(data[:birthday]) if data[:birthday]
+          Date.parse(data[:birthday]) if data[:birthday]
         end
 
         def gender
@@ -204,9 +226,25 @@ module Kentaa
         end
 
         def consent
+          Kentaa::Api::Deprecation.warn('#consent is deprecated. Please use #consents instead.', caller)
+
           @consent ||= Kentaa::Api::Resources::Consent.new(data[:consent]) if data[:consent]
         end
 
+        def consents
+          @consents ||= begin
+            consents = []
+
+            if data[:consents]
+              data[:consents].each do |consent|
+                consents << Kentaa::Api::Resources::Consent.new(consent)
+              end
+            end
+
+            consents
+          end
+        end
+
         private
 
         def load_resource

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'time'
+
+module Kentaa
+  module Api
+    module Resources
+      class DonationForm < Resource
+        def object_key
+          "DonationForm_#{id}"
+        end
+
+        def parent
+          site
+        end
+
+        def site
+          Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
+        end
+
+        def slug
+          data[:slug]
+        end
+
+        def site_id
+          data[:site_id]
+        end
+
+        def owner
+          @owner ||= Kentaa::Api::Resources::User.new(config, data: data[:owner], options: options)
+        end
+
+        def title
+          data[:title]
+        end
+
+        def description
+          data[:description]
+        end
+
+        def total_amount
+          BigDecimal(data[:total_amount])
+        end
+
+        def total_donations
+          data[:total_donations]
+        end
+
+        def published?
+          data[:published]
+        end
+
+        def visible?
+          data[:visible]
+        end
+
+        def external_reference
+          data[:external_reference]
+        end
+
+        def url
+          data[:url]
+        end
+
+        def banners
+          @banners ||= begin
+            banners = []
+
+            if data[:banners]
+              data[:banners].each do |banner|
+                banners << Kentaa::Api::Resources::Banner.new(banner)
+              end
+            end
+
+            banners
+          end
+        end
+
+        def donations
+          @donations ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::Donation, endpoint_path: "/donation-forms/#{id}/donations")
+        end
+
+        def manual_donations
+          @manual_donations ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::ManualDonation, endpoint_path: "/donation-forms/#{id}/manual-donations")
+        end
+
+        def newsletter_subscriptions
+          @newsletter_subscriptions ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::NewsletterSubscription, endpoint_path: "/donation-forms/#{id}/newsletter-subscriptions")
+        end
+
+        def recurring_donors
+          @recurring_donors ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::RecurringDonor, endpoint_path: "/donation-forms/#{id}/recurring-donors")
+        end
+
+        private
+
+        def load_resource
+          request.get("/donation-forms/#{id}", options)
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,20 @@ module Kentaa
   module Api
     module Resources
       class List < Base
+        include Enumerable
+
+        def [](index)
+          resources[index]
+        end
+
+        def size
+          resources.size
+        end
+
+        def each(&block)
+          resources.each(&block)
+        end
+
         def links
           body[:links]
         end
@@ -45,11 +59,11 @@ module Kentaa
         end
 
         def next
-          self.class.new(config, options.merge(page: next_page)) if next_page?
+          self.class.new(config, options.merge(resource_class: resource_class, endpoint_path: endpoint_path, page: next_page)) if next_page?
         end
 
         def previous
-          self.class.new(config, options.merge(page: previous_page)) if previous_page?
+          self.class.new(config, options.merge(resource_class: resource_class, endpoint_path: endpoint_path, page: previous_page)) if previous_page?
         end
 
         def all
@@ -57,7 +71,7 @@ module Kentaa
             page = 1
 
             loop do
-              response = self.class.new(config, options.merge(page: page))
+              response = self.class.new(config, options.merge(resource_class: resource_class, endpoint_path: endpoint_path, page: page))
               response.each { |item| yielder.yield item }
 
               raise StopIteration unless response.next_page?
@@ -68,6 +82,50 @@ module Kentaa
 
           enumerator.lazy
         end
+
+        def get(id, options = {})
+          resource = resource_class.new(config, id: id, options: options.merge(endpoint_path: endpoint_path))
+          resource.load
+        end
+
+        def create(attributes, options = {})
+          resource = resource_class.new(config, options: options.merge(endpoint_path: endpoint_path))
+          resource.save(attributes)
+        end
+
+        def update(id, attributes, options = {})
+          resource = resource_class.new(config, id: id, options: options.merge(endpoint_path: endpoint_path))
+          resource.save(attributes)
+        end
+
+        def delete(id, options = {})
+          resource = resource_class.new(config, id: id, options: options.merge(endpoint_path: endpoint_path))
+          resource.delete
+        end
+
+        private
+
+        def resources
+          @resources ||= begin
+            resources = []
+
+            if data
+              data.each do |resource|
+                resources << resource_class.new(config, data: resource, options: options)
+              end
+            end
+
+            resources
+          end
+        end
+
+        def attribute_key
+          Util.pluralize(resource_class.attribute_key)
+        end
+
+        def load_resource
+          request.get(endpoint_path, options)
+        end
       end
     end
   end

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

@@ -13,22 +13,32 @@ module Kentaa
 
         def entity
           if action_id
-            Kentaa::Api::Resources::Action.new(config, id: action_id)
+            Kentaa::Api::Resources::Action.new(config, id: action_id, options: options)
           elsif team_id
-            Kentaa::Api::Resources::Team.new(config, id: team_id)
+            Kentaa::Api::Resources::Team.new(config, id: team_id, options: options)
           elsif project_id
-            Kentaa::Api::Resources::Project.new(config, id: project_id)
+            Kentaa::Api::Resources::Project.new(config, id: project_id, options: options)
           elsif segment_id
-            Kentaa::Api::Resources::Segment.new(config, id: segment_id)
+            Kentaa::Api::Resources::Segment.new(config, id: segment_id, options: options)
+          elsif donation_form_id
+            Kentaa::Api::Resources::DonationForm.new(config, id: donation_form_id, options: options)
           else
-            Kentaa::Api::Resources::Site.new(config, id: site_id)
+            Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
           end
         end
 
+        def site
+          Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
+        end
+
         def site_id
           data[:site_id]
         end
 
+        def donation_form_id
+          data[:donation_form_id]
+        end
+
         def segment_id
           data[:segment_id]
         end
@@ -58,7 +68,7 @@ module Kentaa
         end
 
         def name
-          [first_name, infix, last_name].reject { |s| s.to_s.empty? }.join(" ")
+          [first_name, infix, last_name].reject { |s| s.to_s.empty? }.join(' ')
         end
 
         def anonymous?
@@ -96,7 +106,7 @@ module Kentaa
         end
 
         def create_resource(attributes)
-          request.post("/manual-donations", options, attributes)
+          request.post('/manual-donations', options, attributes)
         end
 
         def update_resource(attributes)

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

@@ -10,14 +10,20 @@ module Kentaa
 
         def entity
           if project_id
-            Kentaa::Api::Resources::Project.new(config, id: project_id)
+            Kentaa::Api::Resources::Project.new(config, id: project_id, options: options)
           elsif segment_id
-            Kentaa::Api::Resources::Segment.new(config, id: segment_id)
+            Kentaa::Api::Resources::Segment.new(config, id: segment_id, options: options)
+          elsif donation_form_id
+            Kentaa::Api::Resources::DonationForm.new(config, id: donation_form_id, options: options)
           else
-            Kentaa::Api::Resources::Site.new(config, id: site_id)
+            Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
           end
         end
 
+        def site
+          Kentaa::Api::Resources::Site.new(config, id: site_id, options: options)
+        end
+
         def first_name
           data[:first_name]
         end
@@ -31,13 +37,17 @@ module Kentaa
         end
 
         def name
-          [first_name, infix, last_name].reject { |s| s.to_s.empty? }.join(" ")
+          [first_name, infix, last_name].reject { |s| s.to_s.empty? }.join(' ')
         end
 
         def site_id
           data[:site_id]
         end
 
+        def donation_form_id
+          data[:donation_form_id]
+        end
+
         def segment_id
           data[:segment_id]
         end
@@ -59,9 +69,25 @@ module Kentaa
         end
 
         def consent
+          Kentaa::Api::Deprecation.warn('#consent is deprecated. Please use #consents instead.', caller)
+
           @consent ||= Kentaa::Api::Resources::Consent.new(data[:consent]) if data[:consent]
         end
 
+        def consents
+          @consents ||= begin
+            consents = []
+
+            if data[:consents]
+              data[:consents].each do |consent|
+                consents << Kentaa::Api::Resources::Consent.new(consent)
+              end
+            end
+
+            consents
+          end
+        end
+
         private
 
         def load_resource

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'time'
+
+module Kentaa
+  module Api
+    module Resources
+      class Performance < Resource
+        def object_key
+          "ActionPerformance_#{id}"
+        end
+
+        def action_id
+          data[:action_id]
+        end
+
+        def action
+          Kentaa::Api::Resources::Action.new(config, id: action_id, options: options)
+        end
+
+        def title
+          data[:title]
+        end
+
+        def description
+          data[:description]
+        end
+
+        def performance_type
+          data[:performance_type]
+        end
+
+        def performance_at
+          Time.parse(data[:performance_at])
+        end
+
+        def distance
+          BigDecimal(data[:distance])
+        end
+
+        def unit
+          data[:unit]
+        end
+
+        def photos(options = {})
+          @photos ||= Kentaa::Api::Resources::List.new(config, options.merge(resource_class: Kentaa::Api::Resources::PerformancePhoto, endpoint_path: "/actions/#{action_id}/performances/#{id}/photos"))
+        end
+
+        private
+
+        def load_resource
+          request.get("#{endpoint_path}/#{id}", options)
+        end
+
+        def create_resource(attributes)
+          request.post(endpoint_path, options, attributes)
+        end
+
+        def update_resource(attributes)
+          request.patch("#{endpoint_path}/#{id}", options, attributes)
+        end
+
+        def delete_resource
+          request.delete("#{endpoint_path}/#{id}", options)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Kentaa
+  module Api
+    module Resources
+      class PerformancePhoto < Resource
+        class << self
+          def attribute_key
+            'photo'
+          end
+        end
+
+        def object_key
+          "ActionPerformancePhoto_#{id}"
+        end
+
+        def image_url
+          data[:image_url]
+        end
+
+        private
+
+        def load_resource
+          request.get("#{endpoint_path}/#{id}", options)
+        end
+
+        def create_resource(attributes)
+          io = attributes.fetch(:io)
+          content_type = attributes.fetch(:content_type)
+
+          request.post(endpoint_path, options, io, content_type: content_type)
+        end
+      end
+    end
+  end
+end