kentaa-api 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c9f7ea46e68c4af626c227e7ef2bd787d181d487661f60a89c43f5ab7c3d9ac
-  data.tar.gz: dd3725827a82aa19ad4dfa6858e9a9d47b945a33cd8791410f2d2ce57d0c8e29
+  metadata.gz: 8c62a6f7a4458cfe09d6ae1c9afc27460f05c58c8e23d59462a03ef2d59f16cc
+  data.tar.gz: f9b555b9a83ae084ca35ca3690f7dd4c85119bcb4aa7984fee0e32ab9e9eadf9
 SHA512:
-  metadata.gz: 4e03bd106dfab27111bdcb5ef44019b6cd7872254b22c27d91e35ba849b110c3e866a3f22ac6d9e72a7825ed8cef3f7898cfaf7691ac7f3d085a83a9dea4d4d7
-  data.tar.gz: be757c6cc5dd388820d05c400cdf2f59e593c82921b4c71374250ca490118315a4fbe4636bc63217fc4ebf2bbd6492c86efb298fd1d71c047c3b1fe49aaa953b
+  metadata.gz: 0cdf39593639b4e11f13006bc602f084daa45c4fda1770c6a6b827d66bad3f587cafe82cb1f4cea7b8e3a76d4d4aa1afacc39d6fce9fb85c3434efaf69c27131
+  data.tar.gz: c7b0cb509e5ab3215dbdddfb671e6127b3897470edc794e728ca32d21f436e2636afaad21b8d1256b6015b020d1b6af54d31f0ef80cad9622dcb09edb65635dd

data/.rubocop.yml

@@ -40,6 +40,9 @@ Style/Documentation:
 Style/ExpandPathArguments:
   Enabled: false
 
+Style/IfUnlessModifier:
+  Enabled: false
+
 Style/SafeNavigation:
   Enabled: false
 

data/Gemfile.lock

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

data/README.md

@@ -31,14 +31,15 @@ Create the client with your API key:
 ```ruby
 require 'kentaa/api'
 
-client = Kentaa::Api::Client.new('your_api_key')
+config = Kentaa::Api::Config.new('your_api_key')
+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.
 
-The `list` method on the endpoint returns an [Enumerable](https://ruby-doc.org/core-2.3.4/Enumerable.html) object:
+The `list` method on the endpoint returns an [Enumerable](https://ruby-doc.org/core/Enumerable.html) object:
 
 ```ruby
 actions = client.actions.list
@@ -53,9 +54,9 @@ The results might be part of a paginated set. You can query the next page by doi
 actions = client.actions.list(page: actions.next_page) if actions.next_page?
 ```
 
-See also `Kentaa::Api::Responses::Pagination` for the available methods for pagination.
+See also `Kentaa::Api::Resources::Pagination` for the available methods for pagination.
 
-The `all` method on the endpoint returns an [Enumerator](https://ruby-doc.org/core-2.3.4/Enumerator.html) and will iterate automatically through all pages to retrieve the requested data.
+The `all` method on the endpoint returns an [Enumerator](https://ruby-doc.org/core/Enumerator.html) and will iterate automatically through all pages to retrieve the requested data.
 
 ```ruby
 actions = client.actions.all
@@ -78,7 +79,7 @@ action = client.actions.get(1)            # query action by ID
 action = client.actions.get("john-doe")   # query action by slug
 ```
 
-See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/actions).
+See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/actions).
 
 #### Donations
 
@@ -89,7 +90,7 @@ donations = client.donations.all     # get all donations (non-paginated)
 donation = client.donations.get(1)   # query donation by ID
 ```
 
-See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/donations).
+See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/donations).
 
 #### Newsletter subscriptions
 
@@ -101,7 +102,7 @@ newsletter_subscriptions = client.newsletter_subscriptions.list   # get all news
 newsletter_subscriptions = client.newsletter_subscriptions.get(1) # query newsletter subscription by ID
 ```
 
-See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/newsletter-subscriptions).
+See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/newsletter-subscriptions).
 
 #### Projects
 
@@ -113,7 +114,7 @@ project = client.projects.get(1)           # query project by ID
 project = client.projects.get("project")   # query project by slug
 ```
 
-See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/projects).
+See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/projects).
 
 #### Segments
 
@@ -124,7 +125,7 @@ segments = client.segments.all     # get all segments (non-paginated)
 segment = client.segments.get(1)   # query segment by ID
 ```
 
-See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/segments).
+See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/segments).
 
 #### Sites
 
@@ -134,7 +135,7 @@ The only method here is `current`, since there is only one site.
 site = client.sites.current    # get the current site
 ```
 
-See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/sites).
+See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/sites).
 
 #### Teams
 
@@ -146,7 +147,7 @@ team = client.teams.get(1)         # query team by ID
 team = client.teams.get("team")    # query team by slug
 ```
 
-See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/teams).
+See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/teams).
 
 
 #### Users
@@ -158,7 +159,7 @@ users = client.users.all           # get all users (non-paginated)
 user = client.users.get(1)         # query user by ID
 ```
 
-See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/users).
+See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/users).
 
 
 ## Development

data/lib/kentaa/api.rb

@@ -1,49 +1,52 @@
 # frozen_string_literal: true
 
-require_relative "api/requests/base"
-require_relative "api/requests/all"
+require_relative "api/clients/base"
+require_relative "api/clients/all"
 
-require_relative "api/requests/actions"
-require_relative "api/requests/donations"
-require_relative "api/requests/newsletter_subscriptions"
-require_relative "api/requests/projects"
-require_relative "api/requests/segments"
-require_relative "api/requests/sites"
-require_relative "api/requests/teams"
-require_relative "api/requests/users"
+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/responses/base"
-require_relative "api/responses/pagination"
-require_relative "api/responses/resource"
-require_relative "api/responses/status"
+require_relative "api/resources/base"
+require_relative "api/resources/pagination"
+require_relative "api/resources/resource"
+require_relative "api/resources/status"
 
-require_relative "api/responses/action"
-require_relative "api/responses/actions"
-require_relative "api/responses/activity"
-require_relative "api/responses/address"
-require_relative "api/responses/banner"
-require_relative "api/responses/consent"
-require_relative "api/responses/donation"
-require_relative "api/responses/donations"
-require_relative "api/responses/location"
-require_relative "api/responses/newsletter_subscription"
-require_relative "api/responses/newsletter_subscriptions"
-require_relative "api/responses/photo"
-require_relative "api/responses/project"
-require_relative "api/responses/projects"
-require_relative "api/responses/question"
-require_relative "api/responses/registration_fee"
-require_relative "api/responses/reward"
-require_relative "api/responses/segment"
-require_relative "api/responses/segments"
-require_relative "api/responses/site"
-require_relative "api/responses/team"
-require_relative "api/responses/teams"
-require_relative "api/responses/user"
-require_relative "api/responses/users"
-require_relative "api/responses/video"
+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/donation"
+require_relative "api/resources/donations"
+require_relative "api/resources/location"
+require_relative "api/resources/newsletter_subscription"
+require_relative "api/resources/newsletter_subscriptions"
+require_relative "api/resources/photo"
+require_relative "api/resources/project"
+require_relative "api/resources/projects"
+require_relative "api/resources/question"
+require_relative "api/resources/registration_fee"
+require_relative "api/resources/reward"
+require_relative "api/resources/segment"
+require_relative "api/resources/segments"
+require_relative "api/resources/site"
+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"
 
 require_relative "api/client"
+require_relative "api/config"
+require_relative "api/exception"
+require_relative "api/finder"
 require_relative "api/request"
 require_relative "api/response"
 

data/lib/kentaa/api/client.rb

@@ -3,40 +3,40 @@
 module Kentaa
   module Api
     class Client
-      def initialize(api_key, options = {})
-        @request = Kentaa::Api::Request.new(api_key, options)
+      def initialize(config)
+        @config = config
       end
 
       def actions
-        Kentaa::Api::Requests::Actions.new(@request)
+        Kentaa::Api::Clients::Actions.new(@config)
       end
 
       def donations
-        Kentaa::Api::Requests::Donations.new(@request)
+        Kentaa::Api::Clients::Donations.new(@config)
       end
 
       def newsletter_subscriptions
-        Kentaa::Api::Requests::NewsletterSubscriptions.new(@request)
+        Kentaa::Api::Clients::NewsletterSubscriptions.new(@config)
       end
 
       def projects
-        Kentaa::Api::Requests::Projects.new(@request)
+        Kentaa::Api::Clients::Projects.new(@config)
       end
 
       def segments
-        Kentaa::Api::Requests::Segments.new(@request)
+        Kentaa::Api::Clients::Segments.new(@config)
       end
 
       def sites
-        Kentaa::Api::Requests::Sites.new(@request)
+        Kentaa::Api::Clients::Sites.new(@config)
       end
 
       def teams
-        Kentaa::Api::Requests::Teams.new(@request)
+        Kentaa::Api::Clients::Teams.new(@config)
       end
 
       def users
-        Kentaa::Api::Requests::Users.new(@request)
+        Kentaa::Api::Clients::Users.new(@config)
       end
     end
   end

data/lib/kentaa/api/{requests → clients}/actions.rb

@@ -2,18 +2,18 @@
 
 module Kentaa
   module Api
-    module Requests
+    module Clients
       class Actions < Base
-        include Kentaa::Api::Requests::All
+        include Kentaa::Api::Clients::All
 
         def list(options = {})
           response = request.get("/actions", options)
-          Kentaa::Api::Responses::Actions.new(response)
+          Kentaa::Api::Resources::Actions.new(config, response)
         end
 
         def get(id)
           response = request.get("/actions/#{id}")
-          Kentaa::Api::Responses::Action.new(response)
+          Kentaa::Api::Resources::Action.new(config, response)
         end
       end
     end

data/lib/kentaa/api/{requests → clients}/all.rb

@@ -2,7 +2,7 @@
 
 module Kentaa
   module Api
-    module Requests
+    module Clients
       module All
         def all(options = {})
           enumerator = Enumerator.new do |yielder|

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kentaa
+  module Api
+    module Clients
+      class Base
+        attr_reader :config
+
+        def initialize(config)
+          @config = config
+        end
+
+        def request
+          @request ||= Kentaa::Api::Request.new(config)
+        end
+      end
+    end
+  end
+end

data/lib/kentaa/api/{requests → clients}/donations.rb

@@ -2,18 +2,18 @@
 
 module Kentaa
   module Api
-    module Requests
+    module Clients
       class Donations < Base
-        include Kentaa::Api::Requests::All
+        include Kentaa::Api::Clients::All
 
         def list(options = {})
           response = request.get("/donations", options)
-          Kentaa::Api::Responses::Donations.new(response)
+          Kentaa::Api::Resources::Donations.new(config, response)
         end
 
         def get(id)
           response = request.get("/donations/#{id}")
-          Kentaa::Api::Responses::Donation.new(response)
+          Kentaa::Api::Resources::Donation.new(config, response)
         end
       end
     end

data/lib/kentaa/api/{requests → clients}/newsletter_subscriptions.rb

@@ -2,18 +2,18 @@
 
 module Kentaa
   module Api
-    module Requests
+    module Clients
       class NewsletterSubscriptions < Base
-        include Kentaa::Api::Requests::All
+        include Kentaa::Api::Clients::All
 
         def list(options = {})
           response = request.get("/newsletter-subscriptions", options)
-          Kentaa::Api::Responses::NewsletterSubscriptions.new(response)
+          Kentaa::Api::Resources::NewsletterSubscriptions.new(config, response)
         end
 
         def get(id)
           response = request.get("/newsletter-subscriptions/#{id}")
-          Kentaa::Api::Responses::NewsletterSubscription.new(response)
+          Kentaa::Api::Resources::NewsletterSubscription.new(config, response)
         end
       end
     end

data/lib/kentaa/api/{requests → clients}/projects.rb

@@ -2,18 +2,18 @@
 
 module Kentaa
   module Api
-    module Requests
+    module Clients
       class Projects < Base
-        include Kentaa::Api::Requests::All
+        include Kentaa::Api::Clients::All
 
         def list(options = {})
           response = request.get("/projects", options)
-          Kentaa::Api::Responses::Projects.new(response)
+          Kentaa::Api::Resources::Projects.new(config, response)
         end
 
         def get(id)
           response = request.get("/projects/#{id}")
-          Kentaa::Api::Responses::Project.new(response)
+          Kentaa::Api::Resources::Project.new(config, response)
         end
       end
     end

data/lib/kentaa/api/{requests → clients}/segments.rb

@@ -2,18 +2,18 @@
 
 module Kentaa
   module Api
-    module Requests
+    module Clients
       class Segments < Base
-        include Kentaa::Api::Requests::All
+        include Kentaa::Api::Clients::All
 
         def list(options = {})
           response = request.get("/segments", options)
-          Kentaa::Api::Responses::Segments.new(response)
+          Kentaa::Api::Resources::Segments.new(config, response)
         end
 
         def get(id)
           response = request.get("/segments/#{id}")
-          Kentaa::Api::Responses::Segment.new(response)
+          Kentaa::Api::Resources::Segment.new(config, response)
         end
       end
     end

data/lib/kentaa/api/{requests → clients}/sites.rb

@@ -2,11 +2,11 @@
 
 module Kentaa
   module Api
-    module Requests
+    module Clients
       class Sites < Base
         def current
           response = request.get("/sites/current")
-          Kentaa::Api::Responses::Site.new(response)
+          Kentaa::Api::Resources::Site.new(config, response)
         end
       end
     end

data/lib/kentaa/api/{requests → clients}/teams.rb

@@ -2,18 +2,18 @@
 
 module Kentaa
   module Api
-    module Requests
+    module Clients
       class Teams < Base
-        include Kentaa::Api::Requests::All
+        include Kentaa::Api::Clients::All
 
         def list(options = {})
           response = request.get("/teams", options)
-          Kentaa::Api::Responses::Teams.new(response)
+          Kentaa::Api::Resources::Teams.new(config, response)
         end
 
         def get(id)
           response = request.get("/teams/#{id}")
-          Kentaa::Api::Responses::Team.new(response)
+          Kentaa::Api::Resources::Team.new(config, response)
         end
       end
     end