kentaa-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b6fdaf28cb966314b02ab13f42c9c228a1ffedc3
-  data.tar.gz: 55b33406270da3c4d00cf7bcfb5c128b7101af92
+SHA256:
+  metadata.gz: 5c9f7ea46e68c4af626c227e7ef2bd787d181d487661f60a89c43f5ab7c3d9ac
+  data.tar.gz: dd3725827a82aa19ad4dfa6858e9a9d47b945a33cd8791410f2d2ce57d0c8e29
 SHA512:
-  metadata.gz: 6065be812cc0caa5758d9e4afbcbc1fc4ceda6f7bbba77225ffd5274a71a7e33c5d4d15973e04692e08664cd367027894e60c7b1dc493db98b07e46516765594
-  data.tar.gz: e0f51e23b4eb13700cedabebfa70ae3e99733340b3dc3ebd088bb164d1e356c6afc15ae20e05933bfea59351f0dc96ba0e3d2234d46f1879488cd8f7870858cf
+  metadata.gz: 4e03bd106dfab27111bdcb5ef44019b6cd7872254b22c27d91e35ba849b110c3e866a3f22ac6d9e72a7825ed8cef3f7898cfaf7691ac7f3d085a83a9dea4d4d7
+  data.tar.gz: be757c6cc5dd388820d05c400cdf2f59e593c82921b4c71374250ca490118315a4fbe4636bc63217fc4ebf2bbd6492c86efb298fd1d71c047c3b1fe49aaa953b

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -1,26 +1,43 @@
 # Kentaa-API RuboCop configuration
 
+require: rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 2.3
   DisplayCopNames: true
   DisplayStyleGuide: true
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Metrics/AbcSize:
   Enabled: false
 
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/ClassLength:
+  Enabled: false
+
 Metrics/LineLength:
   Enabled: false
 
 Metrics/MethodLength:
   Enabled: false
 
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
+Style/ExpandPathArguments:
   Enabled: false
 
 Style/SafeNavigation:

data/.travis.yml

@@ -1,7 +1,11 @@
 language: ruby
 sudo: false
 cache: bundler
+before_install:
+  - gem update --system
+  - gem update bundler
 rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3

data/Gemfile

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in kentaa-api.gemspec
 gemspec
 
-gem 'rubocop', '~> 0.48.1'
+gem 'rubocop', '~> 0.72.0'
+gem 'rubocop-rspec', '~> 1.33.0'

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    kentaa-api (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    jaro_winkler (1.5.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.33.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.4)
+    unicode-display_width (1.6.0)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  kentaa-api!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.72.0)
+  rubocop-rspec (~> 1.33.0)
+  webmock (~> 2.3, >= 2.3.2)
+
+BUNDLED WITH
+   1.17.1

data/README.md

@@ -96,6 +96,9 @@ See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/donations).
 ```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.get(1) # query newsletter subscription by ID
 ```
 
 See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/newsletter-subscriptions).
@@ -146,6 +149,18 @@ team = client.teams.get("team")    # query team by slug
 See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/teams).
 
 
+#### Users
+
+```ruby
+users = client.users.list          # get users (paginated)
+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).
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "kentaa/api"

data/kentaa-api.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["support@kentaa.nl"]
 
   spec.summary       = "Ruby library for communicating with the Kentaa API"
-  spec.homepage      = "https://www.kentaa.nl"
+  spec.homepage      = "https://github.com/KentaaNL/kentaa-api"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/kentaa/api/client.rb

@@ -1,36 +1,42 @@
+# frozen_string_literal: true
+
 module Kentaa
   module Api
     class Client
       def initialize(api_key, options = {})
-        @http = Kentaa::Api::Http.new(api_key, options)
+        @request = Kentaa::Api::Request.new(api_key, options)
       end
 
       def actions
-        Kentaa::Api::Requests::Actions.new(@http)
+        Kentaa::Api::Requests::Actions.new(@request)
       end
 
       def donations
-        Kentaa::Api::Requests::Donations.new(@http)
+        Kentaa::Api::Requests::Donations.new(@request)
       end
 
       def newsletter_subscriptions
-        Kentaa::Api::Requests::NewsletterSubscriptions.new(@http)
+        Kentaa::Api::Requests::NewsletterSubscriptions.new(@request)
       end
 
       def projects
-        Kentaa::Api::Requests::Projects.new(@http)
+        Kentaa::Api::Requests::Projects.new(@request)
       end
 
       def segments
-        Kentaa::Api::Requests::Segments.new(@http)
+        Kentaa::Api::Requests::Segments.new(@request)
       end
 
       def sites
-        Kentaa::Api::Requests::Sites.new(@http)
+        Kentaa::Api::Requests::Sites.new(@request)
       end
 
       def teams
-        Kentaa::Api::Requests::Teams.new(@http)
+        Kentaa::Api::Requests::Teams.new(@request)
+      end
+
+      def users
+        Kentaa::Api::Requests::Users.new(@request)
       end
     end
   end

data/lib/kentaa/api/{http.rb → request.rb}

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'net/http'
 require 'uri'
 
 module Kentaa
   module Api
-    class Http
-      LIVE_URL = "https://api.kentaa.nl/v1/".freeze
-      TEST_URL = "https://api.kentaa.staatklaar.nu/v1/".freeze
+    class Request
+      LIVE_URL = "https://api.kentaa.nl/v1/"
+      TEST_URL = "https://api.kentaa.staatklaar.nu/v1/"
+      DEV_URL  = "http://api.lvh.me:3000/v1"
 
       def initialize(api_key, options = {})
         @api_key = api_key
@@ -24,13 +27,7 @@ module Kentaa
           http.request(request)
         end
 
-        begin
-          JSON.parse(response.body, symbolize_names: true)
-        rescue JSON::ParserError => ex
-          {
-            message: "Unable to parse JSON: #{ex.message}"
-          }
-        end
+        Kentaa::Api::Response.new(response)
       end
 
       private
@@ -38,6 +35,8 @@ module Kentaa
       def api_url
         if @options[:test]
           TEST_URL
+        elsif @options[:dev]
+          DEV_URL
         else
           LIVE_URL
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kentaa
   module Api
     module Requests
@@ -5,12 +7,12 @@ module Kentaa
         include Kentaa::Api::Requests::All
 
         def list(options = {})
-          response = http.get("/actions", options)
+          response = request.get("/actions", options)
           Kentaa::Api::Responses::Actions.new(response)
         end
 
         def get(id)
-          response = http.get("/actions/#{id}")
+          response = request.get("/actions/#{id}")
           Kentaa::Api::Responses::Action.new(response)
         end
       end

data/lib/kentaa/api/requests/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kentaa
   module Api
     module Requests
@@ -8,7 +10,7 @@ module Kentaa
 
             loop do
               response = list(options.merge(page: page))
-              response.each { |item| yielder.yield item } unless response.error?
+              response.each { |item| yielder.yield item } if response.success?
 
               raise StopIteration unless response.next_page?
 

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

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Kentaa
   module Api
     module Requests
       class Base
-        attr_reader :http
+        attr_reader :request
 
-        def initialize(http)
-          @http = http
+        def initialize(request)
+          @request = request
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kentaa
   module Api
     module Requests
@@ -5,12 +7,12 @@ module Kentaa
         include Kentaa::Api::Requests::All
 
         def list(options = {})
-          response = http.get("/donations", options)
+          response = request.get("/donations", options)
           Kentaa::Api::Responses::Donations.new(response)
         end
 
         def get(id)
-          response = http.get("/donations/#{id}")
+          response = request.get("/donations/#{id}")
           Kentaa::Api::Responses::Donation.new(response)
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kentaa
   module Api
     module Requests
@@ -5,9 +7,14 @@ module Kentaa
         include Kentaa::Api::Requests::All
 
         def list(options = {})
-          response = http.get("/newsletter-subscriptions", options)
+          response = request.get("/newsletter-subscriptions", options)
           Kentaa::Api::Responses::NewsletterSubscriptions.new(response)
         end
+
+        def get(id)
+          response = request.get("/newsletter-subscriptions/#{id}")
+          Kentaa::Api::Responses::NewsletterSubscription.new(response)
+        end
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kentaa
   module Api
     module Requests
@@ -5,12 +7,12 @@ module Kentaa
         include Kentaa::Api::Requests::All
 
         def list(options = {})
-          response = http.get("/projects", options)
+          response = request.get("/projects", options)
           Kentaa::Api::Responses::Projects.new(response)
         end
 
         def get(id)
-          response = http.get("/projects/#{id}")
+          response = request.get("/projects/#{id}")
           Kentaa::Api::Responses::Project.new(response)
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kentaa
   module Api
     module Requests
@@ -5,12 +7,12 @@ module Kentaa
         include Kentaa::Api::Requests::All
 
         def list(options = {})
-          response = http.get("/segments", options)
+          response = request.get("/segments", options)
           Kentaa::Api::Responses::Segments.new(response)
         end
 
         def get(id)
-          response = http.get("/segments/#{id}")
+          response = request.get("/segments/#{id}")
           Kentaa::Api::Responses::Segment.new(response)
         end
       end

data/lib/kentaa/api/requests/sites.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Kentaa
   module Api
     module Requests
       class Sites < Base
         def current
-          response = http.get("/sites/current")
+          response = request.get("/sites/current")
           Kentaa::Api::Responses::Site.new(response)
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kentaa
   module Api
     module Requests
@@ -5,12 +7,12 @@ module Kentaa
         include Kentaa::Api::Requests::All
 
         def list(options = {})
-          response = http.get("/teams", options)
+          response = request.get("/teams", options)
           Kentaa::Api::Responses::Teams.new(response)
         end
 
         def get(id)
-          response = http.get("/teams/#{id}")
+          response = request.get("/teams/#{id}")
           Kentaa::Api::Responses::Team.new(response)
         end
       end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kentaa
+  module Api
+    module Requests
+      class Users < Base
+        include Kentaa::Api::Requests::All
+
+        def list(options = {})
+          response = request.get("/users", options)
+          Kentaa::Api::Responses::Users.new(response)
+        end
+
+        def get(id)
+          response = request.get("/users/#{id}")
+          Kentaa::Api::Responses::User.new(response)
+        end
+      end
+    end
+  end
+end

data/lib/kentaa/api/response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Kentaa
+  module Api
+    class Response
+      attr_reader :response, :body
+
+      def initialize(response)
+        @response = response
+        @body = parse_body(response.body)
+      end
+
+      def code
+        response.code.to_i
+      end
+
+      private
+
+      def parse_body(body)
+        JSON.parse(body, symbolize_names: true)
+      rescue JSON::ParserError => e
+        {
+          message: "Unable to parse JSON: #{e.message}"
+        }
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bigdecimal'
 require 'time'
 
@@ -7,10 +9,6 @@ module Kentaa
       class Action < Base
         include Kentaa::Api::Responses::Resource
 
-        def initialize(response)
-          super(response[:action] || response)
-        end
-
         def slug
           data[:slug]
         end
@@ -28,7 +26,35 @@ module Kentaa
         end
 
         def owner
-          @owner ||= Kentaa::Api::Responses::Owner.new(data[:owner])
+          @owner ||= Kentaa::Api::Responses::User.new(data[:owner])
+        end
+
+        def team_captain?
+          data[:team_captain]
+        end
+
+        def first_name
+          data[:first_name]
+        end
+
+        def infix
+          data[:infix]
+        end
+
+        def last_name
+          data[:last_name]
+        end
+
+        def avatar_url
+          data[:avatar_url]
+        end
+
+        def name
+          [first_name, infix, last_name].compact.join(" ")
+        end
+
+        def fundraiser_page?
+          data[:fundraiser_page]
         end
 
         def title
@@ -44,21 +70,45 @@ module Kentaa
         end
 
         def total_amount
-          BigDecimal.new(data[: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 activity
+          @activity ||= Kentaa::Api::Responses::Activity.new(data[:activity])
+        end
+
+        def previous_participations
+          data[:previous_participations]
+        end
+
         def url
           data[:url]
         end
@@ -67,6 +117,14 @@ module Kentaa
           data[:donate_url]
         end
 
+        def registration_fee
+          @registration_fee ||= Kentaa::Api::Responses::RegistrationFee.new(data[:registration_fee])
+        end
+
+        def location
+          @location ||= Kentaa::Api::Responses::Location.new(data[:location])
+        end
+
         def photos
           @photos ||= begin
             photos = []
@@ -108,6 +166,14 @@ module Kentaa
             questions
           end
         end
+
+        def consent
+          @consent ||= Kentaa::Api::Responses::Consent.new(data[:consent]) if data[:consent]
+        end
+
+        def external_reference
+          data[:external_reference]
+        end
       end
     end
   end