kentaa-api 0.3.0 → 0.6.0

data/kentaa-api.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.0.0"
+  spec.required_ruby_version = ">= 2.4.0"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 2.3", ">= 2.3.2"
 end

data/lib/kentaa/api.rb

@@ -1,43 +1,32 @@
 # frozen_string_literal: true
 
-require_relative "api/clients/base"
-require_relative "api/clients/all"
-
-require_relative "api/clients/actions"
-require_relative "api/clients/donations"
-require_relative "api/clients/newsletter_subscriptions"
-require_relative "api/clients/projects"
-require_relative "api/clients/segments"
-require_relative "api/clients/sites"
-require_relative "api/clients/teams"
-require_relative "api/clients/users"
-
 require_relative "api/resources/base"
+require_relative "api/resources/error"
 require_relative "api/resources/list"
 require_relative "api/resources/resource"
 
 require_relative "api/resources/action"
-require_relative "api/resources/actions"
 require_relative "api/resources/activity"
 require_relative "api/resources/address"
 require_relative "api/resources/banner"
 require_relative "api/resources/consent"
+require_relative "api/resources/contact"
+require_relative "api/resources/donation_form"
 require_relative "api/resources/donation"
-require_relative "api/resources/donations"
 require_relative "api/resources/location"
+require_relative "api/resources/manual_donation"
 require_relative "api/resources/newsletter_subscription"
-require_relative "api/resources/newsletter_subscriptions"
+require_relative "api/resources/performance"
 require_relative "api/resources/photo"
 require_relative "api/resources/project"
-require_relative "api/resources/projects"
-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/segment"
-require_relative "api/resources/segments"
 require_relative "api/resources/site"
+require_relative "api/resources/sites"
 require_relative "api/resources/team"
-require_relative "api/resources/teams"
 require_relative "api/resources/user"
 require_relative "api/resources/users"
 require_relative "api/resources/video"
@@ -45,8 +34,8 @@ require_relative "api/resources/video"
 require_relative "api/client"
 require_relative "api/config"
 require_relative "api/exception"
-require_relative "api/finder"
 require_relative "api/request"
 require_relative "api/response"
+require_relative "api/util"
 
 require_relative "api/version"

data/lib/kentaa/api/client.rb

@@ -3,40 +3,52 @@
 module Kentaa
   module Api
     class Client
-      def initialize(config)
-        @config = config
+      def initialize(options = {})
+        @config = Kentaa::Api::Config.new(options)
       end
 
-      def actions
-        Kentaa::Api::Clients::Actions.new(@config)
+      def actions(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Action, endpoint_path: "/actions"))
       end
 
-      def donations
-        Kentaa::Api::Clients::Donations.new(@config)
+      def donations(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Donation, endpoint_path: "/donations"))
       end
 
-      def newsletter_subscriptions
-        Kentaa::Api::Clients::NewsletterSubscriptions.new(@config)
+      def donation_forms(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::DonationForm, endpoint_path: "/donation-forms"))
       end
 
-      def projects
-        Kentaa::Api::Clients::Projects.new(@config)
+      def manual_donations(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::ManualDonation, endpoint_path: "/manual-donations"))
       end
 
-      def segments
-        Kentaa::Api::Clients::Segments.new(@config)
+      def newsletter_subscriptions(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::NewsletterSubscription, endpoint_path: "/newsletter-subscriptions"))
       end
 
-      def sites
-        Kentaa::Api::Clients::Sites.new(@config)
+      def projects(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Project, endpoint_path: "/projects"))
       end
 
-      def teams
-        Kentaa::Api::Clients::Teams.new(@config)
+      def recurring_donors(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::RecurringDonor, endpoint_path: "/recurring-donors"))
       end
 
-      def users
-        Kentaa::Api::Clients::Users.new(@config)
+      def segments(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Segment, endpoint_path: "/segments"))
+      end
+
+      def sites(options = {})
+        Kentaa::Api::Resources::Sites.new(@config, options)
+      end
+
+      def teams(options = {})
+        Kentaa::Api::Resources::List.new(@config, options.merge(resource_class: Kentaa::Api::Resources::Team, endpoint_path: "/teams"))
+      end
+
+      def users(options = {})
+        Kentaa::Api::Resources::Users.new(@config, options)
       end
     end
   end

data/lib/kentaa/api/config.rb

@@ -7,13 +7,16 @@ module Kentaa
       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/exception.rb

@@ -10,12 +10,19 @@ module Kentaa
 
       def initialize(response)
         @response = response
+        super()
+      end
 
-        super(response.message)
+      def errors
+        response.errors
       end
 
       def http_code
-        response.code
+        response.http_code
+      end
+
+      def to_s
+        "#{response.http_code}: #{response.message}"
       end
     end
   end

data/lib/kentaa/api/request.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'net/http'
 require 'uri'
 
@@ -13,16 +14,55 @@ module Kentaa
       end
 
       def get(path, params = {})
+        request(:get, path, params)
+      end
+
+      def post(path, params = {}, body = {})
+        request(:post, path, params, body)
+      end
+
+      def patch(path, params = {}, body = {})
+        request(:patch, path, params, body)
+      end
+
+      def delete(path, params = {})
+        request(:delete, path, params)
+      end
+
+      private
+
+      def request(http_method, path, params = {}, body = {})
         uri = URI.parse(File.join(config.api_url, path))
         uri.query = URI.encode_www_form(params) unless params.empty?
 
-        request = Net::HTTP::Get.new(uri)
+        case http_method
+        when :get
+          request = Net::HTTP::Get.new(uri)
+        when :post
+          request = Net::HTTP::Post.new(uri)
+          request.body = body.to_json
+        when :patch
+          request = Net::HTTP::Patch.new(uri)
+          request.body = body.to_json
+        when :delete
+          request = Net::HTTP::Delete.new(uri)
+        else
+          raise Kentaa::Api::Exception, "Invalid HTTP method: #{http_method}"
+        end
+
+        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}"
+
+        client = Net::HTTP.new(uri.hostname, uri.port)
+        client.use_ssl = uri.scheme == "https"
+        client.verify_mode = OpenSSL::SSL::VERIFY_PEER
 
         begin
-          result = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
-            http.request(request)
-          end
+          response = Kentaa::Api::Response.new(client.request(request))
         # Try to catch some common exceptions Net::HTTP might raise.
         rescue Errno::ETIMEDOUT, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, Errno::EHOSTUNREACH,
                IOError, SocketError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::OpenTimeout,
@@ -30,7 +70,7 @@ module Kentaa
           raise Kentaa::Api::Exception, e.message
         end
 
-        response = Kentaa::Api::Response.new(result)
+        logger.debug("[Kentaa-API] Response: #{response.http_code}, body: #{response.body}") if config.debug?
 
         if response.error?
           raise Kentaa::Api::RequestError, response
@@ -38,6 +78,10 @@ module Kentaa
 
         response
       end
+
+      def logger
+        @logger ||= Logger.new($stdout)
+      end
     end
   end
 end

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

@@ -13,16 +13,20 @@ module Kentaa
 
         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 +48,11 @@ 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 first_name
@@ -120,7 +124,7 @@ module Kentaa
         end
 
         def activity
-          @activity ||= Kentaa::Api::Resources::Activity.new(config, data: data[:activity])
+          @activity ||= Kentaa::Api::Resources::Activity.new(data[:activity])
         end
 
         def previous_participations
@@ -136,11 +140,11 @@ module Kentaa
         end
 
         def registration_fee
-          @registration_fee ||= Kentaa::Api::Resources::RegistrationFee.new(config, data: data[:registration_fee])
+          @registration_fee ||= Kentaa::Api::Resources::RegistrationFee.new(data[:registration_fee])
         end
 
         def location
-          @location ||= Kentaa::Api::Resources::Location.new(config, data: data[:location])
+          @location ||= Kentaa::Api::Resources::Location.new(data[:location])
         end
 
         def photos
@@ -149,7 +153,7 @@ module Kentaa
 
             if data[:photos]
               data[:photos].each do |photo|
-                photos << Kentaa::Api::Resources::Photo.new(config, data: photo)
+                photos << Kentaa::Api::Resources::Photo.new(photo)
               end
             end
 
@@ -163,7 +167,7 @@ module Kentaa
 
             if data[:videos]
               data[:videos].each do |video|
-                videos << Kentaa::Api::Resources::Video.new(config, data: video)
+                videos << Kentaa::Api::Resources::Video.new(video)
               end
             end
 
@@ -177,7 +181,7 @@ module Kentaa
 
             if data[:questions]
               data[:questions].each do |question|
-                questions << Kentaa::Api::Resources::Question.new(config, data: question)
+                questions << Kentaa::Api::Resources::Question.new(question)
               end
             end
 
@@ -186,18 +190,38 @@ module Kentaa
         end
 
         def consent
-          @consent ||= Kentaa::Api::Resources::Consent.new(config, data: data[:consent]) if data[:consent]
+          @consent ||= Kentaa::Api::Resources::Consent.new(data[:consent]) if data[:consent]
         end
 
         def external_reference
           data[:external_reference]
         end
 
-        protected
+        def donations
+          @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::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")
+        end
+
+        private
 
-        def load_resource(options)
+        def load_resource
           request.get("/actions/#{id}", options)
         end
+
+        def create_resource(attributes)
+          request.post("/actions", options, attributes)
+        end
+
+        def update_resource(attributes)
+          request.patch("/actions/#{id}", options, attributes)
+        end
       end
     end
   end

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

@@ -3,7 +3,17 @@
 module Kentaa
   module Api
     module Resources
-      class Activity < Resource
+      class Activity
+        attr_reader :data
+
+        def initialize(data)
+          @data = data
+        end
+
+        def id
+          data[:id]
+        end
+
         def name
           data[:name]
         end

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

@@ -3,7 +3,13 @@
 module Kentaa
   module Api
     module Resources
-      class Address < Resource
+      class Address
+        attr_reader :data
+
+        def initialize(data)
+          @data = data
+        end
+
         def address
           data[:address]
         end