kentaa-api 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da9bb3b58fe4533c642cd80ca677b29aff5e779aa1335ecbda2ba5c502133487
-  data.tar.gz: 3ad011c17955567de318e2e1c8f959afd3ea3f6aad8d66381f0d2c48abd7c6e5
+  metadata.gz: 1aca25f29280f1c8b1ac63c17a8d8bac967c27a10975027ceaa163ca13a57a09
+  data.tar.gz: 7e9a8a9e7bcc65b8f63de8284db9e8550d238bf75dc8565a2eeb5f147f48e5c3
 SHA512:
-  metadata.gz: 2b00e2f9db7313a96e4d205337ae9c2a9d9872d5ff97865246a6b1b391ae47cd615c2e736eac0ea5a6e890cb553bbfa66d5ddf31b83a60dc6d48f580912a430d
-  data.tar.gz: 50f33d783a2055d71bdbf9bdc446be064bb109b71e04f6736e9dfb29b0dc670fe42001b89c218904405a218b3700c3d030fdd1c1292658b958ba77e62b9dafc3
+  metadata.gz: 5b5889b38da0cf1ed917460cfae3f2c4987c4fe62e48988f865dd1768c2106ca12d726e324f3d3c1f7199b8888848c93ecfcd93ff2a6de5bb6bff01a79418d9a
+  data.tar.gz: bd4b8963915d48a62f44082aa20225b1826c2a0eae40488084c138e78799f06787e7213d6d7bc8b2bd1e7f19de92f3ddbae7ad2e13ec6e2a47fb192d1187c57b

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Peter Postma
+Copyright (c) 2017-2021 Kentaa BV
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -11,11 +11,13 @@ This gem provides a Ruby library for communicating with the [Kentaa API](https:/
 - [Installation](#installation)
 - [Usage](#usage)
   - [Actions](#actions)
+  - [Companies](#companies)
   - [Donation forms](#donation-forms)
   - [Donations](#donations)
   - [Manual donations](#manual-donations)
   - [Newsletter subscriptions](#newsletter-subscriptions)
   - [Performances](#performances)
+    - [Photos](#performance-photos)
   - [Projects](#projects)
   - [Recurring donors](#recurring-donors)
   - [Segments](#segments)
@@ -99,6 +101,29 @@ 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.
 
+
+### Companies
+
+```ruby
+# List Companies
+companies = client.companies       # paginated
+companies = client.companies.all   # non-paginated
+
+companies.each do |company|
+  company.title  # => "Lorem ipsum"
+  company.url  # => "https://demo1.kentaa.nl/bedrijven/kentaa-bv"
+end
+
+# Get Company by ID or slug
+company = client.companies.get(1)
+company = client.companies.get("kentaa-bv")
+
+company.title  # => "Lorem ipsum"
+company.url  # => "https://demo1.kentaa.nl/bedrijven/kentaa-bv"
+```
+
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#companies) and [Kentaa::Api::Resources::Company](lib/kentaa/api/resources/company.rb) for all available properties.
+
 ### Donation forms
 
 ```ruby
@@ -244,16 +269,43 @@ performance.title  # => "First tour"
 performance.distance  # => BigDecimal("65.25")
 
 # Update a Performance
-performance = action.performance.update(1, title: "Big tour")
+performance = action.performances.update(1, title: "Big tour")
 
 performance.title  # => "Big tour"
 
 # Delete a Performance
-action.performance.delete(1)
+action.performances.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.
 
+#### Performance photos
+
+```ruby
+# List Performance photos
+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"
+end
+
+# Get Performance photo
+photo = performance.photos.get(1)
+
+photo.image_url  # => "https://d2a3ux41sjxpco.cloudfront.net/action_performance_photos/file/1/normal_8ce42aeb3bbb1b4964e621b42691f13d4dfa3f21.jpg"
+
+# Create a Performance photo
+photo = performance.photos.create(
+  io: File.open("photo.jpeg"),
+  content_type: "image/jpeg"
+)
+
+photo.image_url  # => "https://d2a3ux41sjxpco.cloudfront.net/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.
+
 ### Projects
 
 ```ruby
@@ -272,7 +324,7 @@ project = client.projects.get("project")
 
 project.title  # => "Dignissimos provident rerum enim alias magni asperna..."
 project.target_amount  # => 250000
-project.url  # => "https://demo1.kentaa.nl/project/dignissimos-provident-rerum-enim-alias-magni-asperna"
+project.url  # => "https://demo1.kentaa.nl/project/dignissimos-provident"
 ```
 
 See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#projects) and [Kentaa::Api::Resources::Project](lib/kentaa/api/resources/project.rb) for all available properties.
@@ -422,7 +474,7 @@ You can iterate through the pages using the `.next` method and checking the resu
 ```ruby
 actions = client.actions
 
-loop do  
+loop do
   actions.each do |action|
     # Do something with actions
   end
@@ -473,4 +525,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Kentaa
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/kentaa/api/client.rb

@@ -8,35 +8,39 @@ module Kentaa
       end
 
       def actions(options = {})
-        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Action, endpoint_path: "/actions"))
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Action, endpoint_path: '/actions'))
+      end
+
+      def companies(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Company, endpoint_path: '/companies'))
       end
 
       def donations(options = {})
-        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Donation, endpoint_path: "/donations"))
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Donation, endpoint_path: '/donations'))
       end
 
       def donation_forms(options = {})
-        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::DonationForm, endpoint_path: "/donation-forms"))
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::DonationForm, endpoint_path: '/donation-forms'))
       end
 
       def manual_donations(options = {})
-        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::ManualDonation, endpoint_path: "/manual-donations"))
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::ManualDonation, endpoint_path: '/manual-donations'))
       end
 
       def newsletter_subscriptions(options = {})
-        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::NewsletterSubscription, endpoint_path: "/newsletter-subscriptions"))
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::NewsletterSubscription, endpoint_path: '/newsletter-subscriptions'))
       end
 
       def projects(options = {})
-        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Project, endpoint_path: "/projects"))
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Project, endpoint_path: '/projects'))
       end
 
       def recurring_donors(options = {})
-        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::RecurringDonor, endpoint_path: "/recurring-donors"))
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::RecurringDonor, endpoint_path: '/recurring-donors'))
       end
 
       def segments(options = {})
-        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Segment, endpoint_path: "/segments"))
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Segment, endpoint_path: '/segments'))
       end
 
       def sites(options = {})
@@ -44,7 +48,7 @@ module Kentaa
       end
 
       def teams(options = {})
-        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Team, endpoint_path: "/teams"))
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Team, endpoint_path: '/teams'))
       end
 
       def users(options = {})

data/lib/kentaa/api/config.rb

@@ -3,9 +3,9 @@
 module Kentaa
   module Api
     class Config
-      LIVE_URL = "https://api.kentaa.nl/v1"
-      TEST_URL = "https://api.kentaa.staatklaar.nu/v1"
-      DEV_URL  = "http://api.lvh.me:3000/v1"
+      LIVE_URL = 'https://api.kentaa.nl/v1'
+      TEST_URL = 'https://api.kentaa.staatklaar.nu/v1'
+      DEV_URL  = 'http://api.lvh.me:3000/v1'
 
       attr_accessor :options
 

data/lib/kentaa/api/deprecation.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kentaa
+  module Api
+    module Deprecation
+      module_function
+
+      def warn(message, callstack = caller)
+        Kernel.warn("DEPRECATION WARNING: #{message} (called from #{callstack.first})")
+      end
+    end
+  end
+end

data/lib/kentaa/api/request.rb

@@ -13,37 +13,48 @@ module Kentaa
         @config = config
       end
 
-      def get(path, params = {})
-        request(:get, path, params)
+      def get(path, params = {}, options = {})
+        request(:get, path, params, nil, options)
       end
 
-      def post(path, params = {}, body = {})
-        request(:post, path, params, body)
+      def post(path, params = {}, body = {}, options = {})
+        request(:post, path, params, body, options)
       end
 
-      def patch(path, params = {}, body = {})
-        request(:patch, path, params, body)
+      def patch(path, params = {}, body = {}, options = {})
+        request(:patch, path, params, body, options)
       end
 
-      def delete(path, params = {})
-        request(:delete, path, params)
+      def delete(path, params = {}, options = {})
+        request(:delete, path, params, nil, options)
       end
 
       private
 
-      def request(http_method, path, params = {}, body = {})
+      def request(http_method, path, params = {}, body = nil, options = {})
         uri = URI.parse(File.join(config.api_url, path))
         uri.query = URI.encode_www_form(params) unless params.empty?
 
+        content_type = options.fetch(:content_type, 'application/json')
+
+        # Body can be passed as an IO-like object or an object that can be serialized to JSON.
+        if body
+          if body.respond_to?(:read)
+            body = body.read
+          elsif body.respond_to?(:to_json)
+            body = body.to_json
+          end
+        end
+
         case http_method
         when :get
           request = Net::HTTP::Get.new(uri)
         when :post
           request = Net::HTTP::Post.new(uri)
-          request.body = body.to_json
+          request.body = body
         when :patch
           request = Net::HTTP::Patch.new(uri)
-          request.body = body.to_json
+          request.body = body
         when :delete
           request = Net::HTTP::Delete.new(uri)
         else
@@ -52,13 +63,13 @@ module Kentaa
 
         logger.debug("[Kentaa-API] Request: #{http_method.upcase} #{uri}") if config.debug?
 
-        request["Accept"] = "application/json"
-        request["Content-Type"] = "application/json"
-        request["X-Api-Key"] = config.api_key
-        request["User-Agent"] = "Ruby kentaa-api/#{Kentaa::Api::VERSION}"
+        request['Accept'] = 'application/json'
+        request['Content-Type'] = content_type
+        request['X-Api-Key'] = config.api_key
+        request['User-Agent'] = "Ruby kentaa-api/#{Kentaa::Api::VERSION}"
 
         client = Net::HTTP.new(uri.hostname, uri.port)
-        client.use_ssl = uri.scheme == "https"
+        client.use_ssl = uri.scheme == 'https'
         client.verify_mode = OpenSSL::SSL::VERIFY_PEER
 
         begin
@@ -72,9 +83,7 @@ module Kentaa
 
         logger.debug("[Kentaa-API] Response: #{response.http_code}, body: #{response.body}") if config.debug?
 
-        if response.error?
-          raise Kentaa::Api::RequestError, response
-        end
+        raise Kentaa::Api::RequestError, response if response.error?
 
         response
       end

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

@@ -7,6 +7,9 @@ module Kentaa
   module Api
     module Resources
       class Action < Resource
+        WHO_TYPE_OWNER = 'owner'
+        WHO_TYPE_OTHER = 'other'
+
         def object_key
           "Action_#{id}"
         end
@@ -55,6 +58,18 @@ module Kentaa
           data.fetch(:team_captain, false)
         end
 
+        def who_type
+          data[:who_type]
+        end
+
+        def owner?
+          who_type == WHO_TYPE_OWNER
+        end
+
+        def other?
+          who_type == WHO_TYPE_OTHER
+        end
+
         def first_name
           data[:first_name]
         end
@@ -72,7 +87,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 fundraiser_page?
@@ -124,7 +139,7 @@ module Kentaa
         end
 
         def activity
-          @activity ||= Kentaa::Api::Resources::Activity.new(data[:activity])
+          @activity ||= Kentaa::Api::Resources::Activity.new(data[:activity]) if data[:activity]
         end
 
         def previous_participations
@@ -190,9 +205,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
+
         def external_reference
           data[:external_reference]
         end
@@ -205,8 +236,8 @@ module Kentaa
           @manual_donations ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::ManualDonation, endpoint_path: "/actions/#{id}/manual-donations")
         end
 
-        def performances
-          @performances ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::Performance, endpoint_path: "/actions/#{id}/performances")
+        def performances(options = {})
+          @performances ||= Kentaa::Api::Resources::List.new(config, options.merge(resource_class: Kentaa::Api::Resources::Performance, endpoint_path: "/actions/#{id}/performances"))
         end
 
         private
@@ -216,7 +247,7 @@ module Kentaa
         end
 
         def create_resource(attributes)
-          request.post("/actions", options, attributes)
+          request.post('/actions', options, attributes)
         end
 
         def update_resource(attributes)

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Kentaa
+  module Api
+    module Resources
+      class Billing
+        attr_reader :data
+
+        def initialize(data)
+          @data = data
+        end
+
+        def attn
+          data[:attn]
+        end
+
+        def street
+          data[:street]
+        end
+
+        def house_number
+          data[:house_number]
+        end
+
+        def house_number_addition
+          data[:house_number_addition]
+        end
+
+        def address
+          data[:address]
+        end
+
+        def address2
+          data[:address2]
+        end
+
+        def zipcode
+          data[:zipcode]
+        end
+
+        def city
+          data[:city]
+        end
+
+        def country
+          data[:country]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'time'
+
+module Kentaa
+  module Api
+    module Resources
+      class Company < Resource
+        def object_key
+          "Company_#{id}"
+        end
+
+        def parent
+          if 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, options: options)
+          else
+            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 slug
+          data[:slug]
+        end
+
+        def site_id
+          data[:site_id]
+        end
+
+        def segment_id
+          data[:segment_id]
+        end
+
+        def project_id
+          data[:project_id]
+        end
+
+        def owner
+          @owner ||= Kentaa::Api::Resources::User.new(config, data: data[:owner], options: options)
+        end
+
+        def members
+          @members ||= begin
+            members = []
+
+            if data[:members]
+              data[:members].each do |member|
+                members << Kentaa::Api::Resources::Action.new(config, data: member, options: options)
+              end
+            end
+
+            members
+          end
+        end
+
+        def name
+          data[:name]
+        end
+
+        def title
+          data[:title]
+        end
+
+        def description
+          data[:description]
+        end
+
+        def target_amount
+          data[:target_amount]
+        end
+
+        def total_amount
+          BigDecimal(data[:total_amount])
+        end
+
+        def total_donations
+          data[:total_donations]
+        end
+
+        def target_amount_achieved?
+          data[:target_amount_achieved]
+        end
+
+        def visible?
+          data[:visible]
+        end
+
+        def countable?
+          data[:countable]
+        end
+
+        def closed?
+          data[:closed]
+        end
+
+        def ended?
+          data[:ended]
+        end
+
+        def end_date
+          Time.parse(data[:end_date]) if data[:end_date]
+        end
+
+        def url
+          data[:url]
+        end
+
+        def donate_url
+          data[:donate_url]
+        end
+
+        def member_sign_up_url
+          data[:member_sign_up_url]
+        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
+
+        def questions
+          @questions ||= begin
+            questions = []
+
+            if data[:questions]
+              data[:questions].each do |question|
+                questions << Kentaa::Api::Resources::Question.new(question)
+              end
+            end
+
+            questions
+          end
+        end
+
+        def company_package
+          @company_package ||= Kentaa::Api::Resources::CompanyPackage.new(data[:package]) if data[:package]
+        end
+
+        def activity
+          @activity ||= Kentaa::Api::Resources::Activity.new(data[:activity]) if data[:activity]
+        end
+
+        def contact
+          @contact ||= Kentaa::Api::Resources::Contact.new(data[:contact]) if data[:contact]
+        end
+
+        def external_reference
+          data[:external_reference]
+        end
+
+        def commerce_number
+          data[:commerce_number]
+        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
+
+        def billing
+          @billing ||= Kentaa::Api::Resources::Billing.new(data[:billing]) if data[:billing]
+        end
+
+        def donations
+          @donations ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::Donation, endpoint_path: "/companies/#{id}/donations")
+        end
+
+        def manual_donations
+          @manual_donations ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::ManualDonation, endpoint_path: "/companies/#{id}/manual-donations")
+        end
+
+        private
+
+        def load_resource
+          request.get("/companies/#{id}", options)
+        end
+      end
+    end
+  end
+end