kentaa-api 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcbbd3d3b46eccb8bf6224cee26a3324db3abae8a61f16a1988eb098ef736dac
-  data.tar.gz: 4dbec5d42ba8db8db765004ccbb6e3991ec70f5a32394c0a89fe6607888a622e
+  metadata.gz: 4ebca7b73a3ae49b7d9948211b21638e7131340fe58f6b34551260853dd4b6fb
+  data.tar.gz: cc9a8b5450c1b4068867a2bf0eada220174e3d107ae2369ddbc5080bcf785257
 SHA512:
-  metadata.gz: 1acabd32a16472d377ee191f72791f2664574494e07e106fa2ee633d2a21332de2614bffdea797d3bd1d52c65516f454c8357b9bfd5357cf56ad755c4215a8d0
-  data.tar.gz: 83efd25c71013041ba37f8c36d488417501f6e080cd1172adb166517ad132c3776fa61cdfd0d38fbb2f581c52eb1088bbf27101feb52bd4b4f37a24730f00a83
+  metadata.gz: 2815897919718da19a9ed6ddb05589523b492639427fced920168bb469c794a83c5cc4477f9dc3403e7a932f6d88d657035a741f5cb3a44c075807b88b3ccf0f
+  data.tar.gz: 696d64f0bf684fafcbf1c38c24f3f1b03c97312f2c6b666054464b85b58b0907eb27e8a42bffd4e886d035475daaab8e22354af9a39ce9ea9a54943fbd225962

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kentaa-api (0.3.2)
+    kentaa-api (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -37,7 +37,7 @@ client = Kentaa::Api::Client.new(config)
 
 ### Retrieving data
 
-All endpoints use the same convention for retrieving data. The methods `list` and `all` are used for retrieving multiple resources. The method `get` is used for retrieving a single resource.
+All endpoints use the same convention for retrieving data. The method `list` is for retrieving multiple resources. The method `get` is used for retrieving a single resource.
 
 The `list` method on the endpoint returns an [Enumerable](https://ruby-doc.org/core/Enumerable.html) object:
 
@@ -51,7 +51,7 @@ actions.first
 The results might be part of a paginated set. You can query the next page by doing:
 
 ```ruby
-actions = client.actions.list(page: actions.next_page) if actions.next_page?
+actions = actions.next if actions.next_page?
 ```
 
 See also `Kentaa::Api::Resources::List` for the available methods for pagination.
@@ -84,10 +84,10 @@ See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/actions).
 #### Donations
 
 ```ruby
-donations = client.donations.list    # get donations (paginated)
-donations = client.donations.all     # get all donations (non-paginated)
+donations = client.donations.list      # get donations (paginated)
+donations = client.donations.all       # get all donations (non-paginated)
 
-donation = client.donations.get(1)   # query donation by ID
+donation = client.donations.get(1)     # query donation by ID
 ```
 
 See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/donations).
@@ -95,11 +95,11 @@ See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/donations).
 #### Newsletter subscriptions
 
 ```ruby
-newsletter_subscriptions = client.newsletter_subscriptions.all    # get newsletter subscriptions (paginated)
-newsletter_subscriptions = client.newsletter_subscriptions.list   # get all newsletter subscriptions (non-paginated)
+newsletter_subscriptions = client.newsletter_subscriptions.list       # get newsletter subscriptions (paginated)
+newsletter_subscriptions = client.newsletter_subscriptions.all        # get all newsletter subscriptions (non-paginated)
 
 
-newsletter_subscriptions = client.newsletter_subscriptions.get(1) # query newsletter subscription by ID
+newsletter_subscriptions = client.newsletter_subscriptions.get(1)     # query newsletter subscription by ID
 ```
 
 See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/newsletter-subscriptions).
@@ -119,10 +119,10 @@ See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/projects).
 #### Segments
 
 ```ruby
-segments = client.segments.list    # get segments (paginated)
-segments = client.segments.all     # get all segments (non-paginated)
+segments = client.segments.list       # get segments (paginated)
+segments = client.segments.all        # get all segments (non-paginated)
 
-segment = client.segments.get(1)   # query segment by ID
+segment = client.segments.get(1)      # query segment by ID
 ```
 
 See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/segments).

data/lib/kentaa/api.rb

@@ -1,10 +1,9 @@
 # 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/manual_donations"
 require_relative "api/clients/newsletter_subscriptions"
 require_relative "api/clients/projects"
 require_relative "api/clients/segments"
@@ -13,6 +12,7 @@ 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"
 
@@ -26,6 +26,8 @@ require_relative "api/resources/contact"
 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/manual_donations"
 require_relative "api/resources/newsletter_subscription"
 require_relative "api/resources/newsletter_subscriptions"
 require_relative "api/resources/photo"

data/lib/kentaa/api/client.rb

@@ -15,6 +15,10 @@ module Kentaa
         Kentaa::Api::Clients::Donations.new(@config)
       end
 
+      def manual_donations
+        Kentaa::Api::Clients::ManualDonations.new(@config)
+      end
+
       def newsletter_subscriptions
         Kentaa::Api::Clients::NewsletterSubscriptions.new(@config)
       end

data/lib/kentaa/api/clients/actions.rb

@@ -4,7 +4,10 @@ module Kentaa
   module Api
     module Clients
       class Actions < Base
-        include Kentaa::Api::Clients::All
+        def all(options = {})
+          actions = Kentaa::Api::Resources::Actions.new(config, options)
+          actions.all
+        end
 
         def list(options = {})
           actions = Kentaa::Api::Resources::Actions.new(config, options)
@@ -15,6 +18,16 @@ module Kentaa
           action = Kentaa::Api::Resources::Action.new(config, options.merge(id: id))
           action.load
         end
+
+        def create(attributes = {}, options = {})
+          action = Kentaa::Api::Resources::Actions.new(config, options)
+          action.create(attributes)
+        end
+
+        def update(id, attributes = {}, options = {})
+          action = Kentaa::Api::Resources::Action.new(config, options.merge(id: id))
+          action.save(attributes)
+        end
       end
     end
   end

data/lib/kentaa/api/clients/donations.rb

@@ -4,7 +4,10 @@ module Kentaa
   module Api
     module Clients
       class Donations < Base
-        include Kentaa::Api::Clients::All
+        def all(options = {})
+          donations = Kentaa::Api::Resources::Donations.new(config, options)
+          donations.all
+        end
 
         def list(options = {})
           donations = Kentaa::Api::Resources::Donations.new(config, options)

data/lib/kentaa/api/clients/manual_donations.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Kentaa
+  module Api
+    module Clients
+      class ManualDonations < Base
+        def all(options = {})
+          donations = Kentaa::Api::Resources::ManualDonations.new(config, options)
+          donations.all
+        end
+
+        def list(options = {})
+          donations = Kentaa::Api::Resources::ManualDonations.new(config, options)
+          donations.load
+        end
+
+        def get(id, options = {})
+          donation = Kentaa::Api::Resources::ManualDonation.new(config, options.merge(id: id))
+          donation.load
+        end
+
+        def create(attributes = {}, options = {})
+          donation = Kentaa::Api::Resources::ManualDonation.new(config, options)
+          donation.save(attributes)
+        end
+
+        def update(id, attributes = {}, options = {})
+          donation = Kentaa::Api::Resources::ManualDonation.new(config, options.merge(id: id))
+          donation.save(attributes)
+        end
+
+        def delete(id, options = {})
+          donation = Kentaa::Api::Resources::ManualDonation.new(config, options.merge(id: id))
+          donation.delete
+        end
+      end
+    end
+  end
+end

data/lib/kentaa/api/clients/newsletter_subscriptions.rb

@@ -4,7 +4,10 @@ module Kentaa
   module Api
     module Clients
       class NewsletterSubscriptions < Base
-        include Kentaa::Api::Clients::All
+        def all(options = {})
+          newsletter_subscriptions = Kentaa::Api::Resources::NewsletterSubscriptions.new(config, options)
+          newsletter_subscriptions.all
+        end
 
         def list(options = {})
           newsletter_subscriptions = Kentaa::Api::Resources::NewsletterSubscriptions.new(config, options)

data/lib/kentaa/api/clients/projects.rb

@@ -4,7 +4,10 @@ module Kentaa
   module Api
     module Clients
       class Projects < Base
-        include Kentaa::Api::Clients::All
+        def all(options = {})
+          projects = Kentaa::Api::Resources::Projects.new(config, options)
+          projects.all
+        end
 
         def list(options = {})
           projects = Kentaa::Api::Resources::Projects.new(config, options)

data/lib/kentaa/api/clients/segments.rb

@@ -4,7 +4,10 @@ module Kentaa
   module Api
     module Clients
       class Segments < Base
-        include Kentaa::Api::Clients::All
+        def all(options = {})
+          segments = Kentaa::Api::Resources::Segments.new(config, options)
+          segments.all
+        end
 
         def list(options = {})
           segments = Kentaa::Api::Resources::Segments.new(config, options)

data/lib/kentaa/api/clients/teams.rb

@@ -4,7 +4,10 @@ module Kentaa
   module Api
     module Clients
       class Teams < Base
-        include Kentaa::Api::Clients::All
+        def all(options = {})
+          teams = Kentaa::Api::Resources::Teams.new(config, options)
+          teams.all
+        end
 
         def list(options = {})
           teams = Kentaa::Api::Resources::Teams.new(config, options)

data/lib/kentaa/api/clients/users.rb

@@ -4,7 +4,10 @@ module Kentaa
   module Api
     module Clients
       class Users < Base
-        include Kentaa::Api::Clients::All
+        def all(options = {})
+          users = Kentaa::Api::Resources::Users.new(config, options)
+          users.all
+        end
 
         def list(options = {})
           users = Kentaa::Api::Resources::Users.new(config, options)
@@ -15,6 +18,16 @@ module Kentaa
           user = Kentaa::Api::Resources::User.new(config, options.merge(id: id))
           user.load
         end
+
+        def create(attributes = {}, options = {})
+          user = Kentaa::Api::Resources::Users.new(config, options)
+          user.create(attributes)
+        end
+
+        def update(id, attributes = {}, options = {})
+          user = Kentaa::Api::Resources::User.new(config, options.merge(id: id))
+          user.save(attributes)
+        end
       end
     end
   end

data/lib/kentaa/api/exception.rb

@@ -14,6 +14,10 @@ module Kentaa
         super(response.message)
       end
 
+      def errors
+        response.errors
+      end
+
       def http_code
         response.http_code
       end

data/lib/kentaa/api/request.rb

@@ -13,16 +13,53 @@ 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
+
+        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,8 +67,6 @@ module Kentaa
           raise Kentaa::Api::Exception, e.message
         end
 
-        response = Kentaa::Api::Response.new(result)
-
         if response.error?
           raise Kentaa::Api::RequestError, response
         end

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

@@ -120,7 +120,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 +136,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 +149,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 +163,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 +177,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 +186,34 @@ 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::Donations.new(config, action_id: id)
+        end
+
+        def manual_donations
+          @manual_donations ||= Kentaa::Api::Resources::ManualDonations.new(config, action_id: id)
+        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