kentaa-api 0.4.0 → 0.7.0

data/lib/kentaa/api/config.rb

@@ -3,17 +3,20 @@
 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 :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
@@ -34,6 +37,10 @@ module Kentaa
           :live
         end
       end
+
+      def debug?
+        options.fetch(:debug, false)
+      end
     end
   end
 end

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/exception.rb

@@ -10,8 +10,7 @@ module Kentaa
 
       def initialize(response)
         @response = response
-
-        super(response.message)
+        super()
       end
 
       def errors
@@ -21,6 +20,10 @@ module Kentaa
       def http_code
         response.http_code
       end
+
+      def to_s
+        "#{response.http_code}: #{response.message}"
+      end
     end
   end
 end

data/lib/kentaa/api/request.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'net/http'
 require 'uri'
 
@@ -12,50 +13,63 @@ 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
           raise Kentaa::Api::Exception, "Invalid HTTP method: #{http_method}"
         end
 
-        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}"
+        logger.debug("[Kentaa-API] Request: #{http_method.upcase} #{uri}") if config.debug?
+
+        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
@@ -67,12 +81,16 @@ module Kentaa
           raise Kentaa::Api::Exception, e.message
         end
 
-        if response.error?
-          raise Kentaa::Api::RequestError, response
-        end
+        logger.debug("[Kentaa-API] Response: #{response.http_code}, body: #{response.body}") if config.debug?
+
+        raise Kentaa::Api::RequestError, response if response.error?
 
         response
       end
+
+      def logger
+        @logger ||= Logger.new($stdout)
+      end
     end
   end
 end

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

@@ -7,22 +7,29 @@ module Kentaa
   module Api
     module Resources
       class Action < Resource
+        WHO_TYPE_OWNER = 'owner'
+        WHO_TYPE_OTHER = 'other'
+
         def object_key
           "Action_#{id}"
         end
 
         def parent
           if 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)
           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 slug
           data[:slug]
         end
@@ -44,11 +51,23 @@ module Kentaa
         end
 
         def owner
-          @owner ||= Kentaa::Api::Resources::User.new(config, data: data[:owner])
+          @owner ||= Kentaa::Api::Resources::User.new(config, data: data[:owner], options: options)
         end
 
         def team_captain?
-          data[:team_captain]
+          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
@@ -68,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?
@@ -120,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
@@ -186,19 +205,39 @@ 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
 
         def donations
-          @donations ||= Kentaa::Api::Resources::Donations.new(config, action_id: id)
+          @donations ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::Donation, endpoint_path: "/actions/#{id}/donations")
         end
 
         def manual_donations
-          @manual_donations ||= Kentaa::Api::Resources::ManualDonations.new(config, action_id: id)
+          @manual_donations ||= Kentaa::Api::Resources::List.new(config, resource_class: Kentaa::Api::Resources::ManualDonation, endpoint_path: "/actions/#{id}/manual-donations")
+        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
 
         private
@@ -208,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/base.rb

@@ -4,15 +4,29 @@ module Kentaa
   module Api
     module Resources
       class Base
-        attr_reader :config, :options
+        attr_reader :config, :options, :resource_class, :endpoint_path
 
         def initialize(config, options = {})
           @config = config
           @options = options
+          @resource_class = options.delete(:resource_class) || self.class
+          @endpoint_path = options.delete(:endpoint_path)
+        end
+
+        class << self
+          def attribute_key
+            class_name = name.split('::').last
+            class_name.gsub(/([^\^])([A-Z])/, '\1_\2').downcase
+          end
         end
 
         def load
-          @response ||= load_resource
+          @response ||=
+            if block_given?
+              yield
+            else
+              load_resource
+            end
 
           self
         end
@@ -24,8 +38,7 @@ module Kentaa
         private
 
         def attribute_key
-          class_name = self.class.name.split('::').last
-          class_name.gsub(/([^\^])([A-Z])/, '\1_\2').downcase.to_sym
+          self.class.attribute_key
         end
 
         def load_resource
@@ -36,7 +49,7 @@ module Kentaa
           @data ||= begin
             load unless loaded?
 
-            @response.body[attribute_key] || {}
+            @response.body[attribute_key.to_sym] || {}
           end
         end
 

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

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Kentaa
+  module Api
+    module Resources
+      class CompanyPackage
+        attr_reader :data
+
+        def initialize(data)
+          @data = data
+        end
+
+        def id
+          data[:id]
+        end
+
+        def created_at
+          Time.parse(data[:created_at]) if data[:created_at]
+        end
+
+        def updated_at
+          Time.parse(data[:updated_at]) if data[:updated_at]
+        end
+
+        def amount
+          data[:amount]
+        end
+
+        def title
+          data[:title]
+        end
+
+        def description
+          data[:description]
+        end
+      end
+    end
+  end
+end