kentaa-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6fdaf28cb966314b02ab13f42c9c228a1ffedc3
+  data.tar.gz: 55b33406270da3c4d00cf7bcfb5c128b7101af92
+SHA512:
+  metadata.gz: 6065be812cc0caa5758d9e4afbcbc1fc4ceda6f7bbba77225ffd5274a71a7e33c5d4d15973e04692e08664cd367027894e60c7b1dc493db98b07e46516765594
+  data.tar.gz: e0f51e23b4eb13700cedabebfa70ae3e99733340b3dc3ebd088bb164d1e356c6afc15ae20e05933bfea59351f0dc96ba0e3d2234d46f1879488cd8f7870858cf

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,33 @@
+# Kentaa-API RuboCop configuration
+
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Peter Postma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,163 @@
+# Kentaa API
+
+[![Gem Version](https://badge.fury.io/rb/kentaa-api.svg)](https://badge.fury.io/rb/kentaa-api)
+[![Build Status](https://travis-ci.org/KentaaNL/kentaa-api.svg?branch=master)](https://travis-ci.org/KentaaNL/kentaa-api)
+[![Code Climate](https://codeclimate.com/github/KentaaNL/kentaa-api/badges/gpa.svg)](https://codeclimate.com/github/KentaaNL/kentaa-api)
+
+This gem provides a Ruby library for communicating with the [Kentaa API](https://api.kentaa.nl/v1/doc).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kentaa-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kentaa-api
+
+## Usage
+
+### Initialization
+
+Create the client with your API key:
+
+```ruby
+require 'kentaa/api'
+
+client = Kentaa::Api::Client.new('your_api_key')
+```
+
+### 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:
+
+```ruby
+actions = client.actions.list
+
+actions.each { |a| puts a.title }
+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?
+```
+
+See also `Kentaa::Api::Responses::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.
+
+```ruby
+actions = client.actions.all
+
+actions.each { |a| puts a.title }
+actions.first(100)
+```
+
+### Requests
+
+Below a summary of the supported requests per endpoint.
+
+#### Actions
+
+```ruby
+actions = client.actions.list             # get actions (paginated)
+actions = client.actions.all              # get all actions (non-paginated)
+
+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).
+
+#### Donations
+
+```ruby
+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
+```
+
+See also the [Kentaa API documention](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)
+```
+
+See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/newsletter-subscriptions).
+
+#### Projects
+
+```ruby
+projects = client.projects.list            # get projects (paginated)
+projects = client.projects.all             # get all projects (non-paginated)
+
+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).
+
+#### Segments
+
+```ruby
+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
+```
+
+See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/segments).
+
+#### Sites
+
+The only method here is `current`, since there is only one site.
+
+```ruby
+site = client.sites.current    # get the current site
+```
+
+See also the [Kentaa API documention](https://api.kentaa.nl/v1/doc/sites).
+
+#### Teams
+
+```ruby
+teams = client.teams.list          # get teams (paginated)
+teams = client.teams.all           # get all teams (non-paginated)
+
+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).
+
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/KentaaNL/kentaa-api.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kentaa/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kentaa-api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kentaa/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kentaa-api"
+  spec.version       = Kentaa::Api::VERSION
+  spec.authors       = ["Kentaa"]
+  spec.email         = ["support@kentaa.nl"]
+
+  spec.summary       = "Ruby library for communicating with the Kentaa API"
+  spec.homepage      = "https://www.kentaa.nl"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.3", ">= 2.3.2"
+end

data/lib/kentaa/api/client.rb

@@ -0,0 +1,37 @@
+module Kentaa
+  module Api
+    class Client
+      def initialize(api_key, options = {})
+        @http = Kentaa::Api::Http.new(api_key, options)
+      end
+
+      def actions
+        Kentaa::Api::Requests::Actions.new(@http)
+      end
+
+      def donations
+        Kentaa::Api::Requests::Donations.new(@http)
+      end
+
+      def newsletter_subscriptions
+        Kentaa::Api::Requests::NewsletterSubscriptions.new(@http)
+      end
+
+      def projects
+        Kentaa::Api::Requests::Projects.new(@http)
+      end
+
+      def segments
+        Kentaa::Api::Requests::Segments.new(@http)
+      end
+
+      def sites
+        Kentaa::Api::Requests::Sites.new(@http)
+      end
+
+      def teams
+        Kentaa::Api::Requests::Teams.new(@http)
+      end
+    end
+  end
+end

data/lib/kentaa/api/http.rb

@@ -0,0 +1,47 @@
+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
+
+      def initialize(api_key, options = {})
+        @api_key = api_key
+        @options = options
+      end
+
+      def get(path, params = {})
+        uri = URI.parse(File.join(api_url, path))
+        uri.query = URI.encode_www_form(params) unless params.empty?
+
+        request = Net::HTTP::Get.new(uri)
+        request["X-Api-Key"] = @api_key
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
+          http.request(request)
+        end
+
+        begin
+          JSON.parse(response.body, symbolize_names: true)
+        rescue JSON::ParserError => ex
+          {
+            message: "Unable to parse JSON: #{ex.message}"
+          }
+        end
+      end
+
+      private
+
+      def api_url
+        if @options[:test]
+          TEST_URL
+        else
+          LIVE_URL
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Kentaa
+  module Api
+    module Requests
+      class Actions < Base
+        include Kentaa::Api::Requests::All
+
+        def list(options = {})
+          response = http.get("/actions", options)
+          Kentaa::Api::Responses::Actions.new(response)
+        end
+
+        def get(id)
+          response = http.get("/actions/#{id}")
+          Kentaa::Api::Responses::Action.new(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Kentaa
+  module Api
+    module Requests
+      module All
+        def all(options = {})
+          enumerator = Enumerator.new do |yielder|
+            page = 1
+
+            loop do
+              response = list(options.merge(page: page))
+              response.each { |item| yielder.yield item } unless response.error?
+
+              raise StopIteration unless response.next_page?
+
+              page = response.next_page
+            end
+          end
+
+          enumerator.lazy
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Kentaa
+  module Api
+    module Requests
+      class Base
+        attr_reader :http
+
+        def initialize(http)
+          @http = http
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Kentaa
+  module Api
+    module Requests
+      class Donations < Base
+        include Kentaa::Api::Requests::All
+
+        def list(options = {})
+          response = http.get("/donations", options)
+          Kentaa::Api::Responses::Donations.new(response)
+        end
+
+        def get(id)
+          response = http.get("/donations/#{id}")
+          Kentaa::Api::Responses::Donation.new(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Kentaa
+  module Api
+    module Requests
+      class NewsletterSubscriptions < Base
+        include Kentaa::Api::Requests::All
+
+        def list(options = {})
+          response = http.get("/newsletter-subscriptions", options)
+          Kentaa::Api::Responses::NewsletterSubscriptions.new(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Kentaa
+  module Api
+    module Requests
+      class Projects < Base
+        include Kentaa::Api::Requests::All
+
+        def list(options = {})
+          response = http.get("/projects", options)
+          Kentaa::Api::Responses::Projects.new(response)
+        end
+
+        def get(id)
+          response = http.get("/projects/#{id}")
+          Kentaa::Api::Responses::Project.new(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Kentaa
+  module Api
+    module Requests
+      class Segments < Base
+        include Kentaa::Api::Requests::All
+
+        def list(options = {})
+          response = http.get("/segments", options)
+          Kentaa::Api::Responses::Segments.new(response)
+        end
+
+        def get(id)
+          response = http.get("/segments/#{id}")
+          Kentaa::Api::Responses::Segment.new(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Kentaa
+  module Api
+    module Requests
+      class Sites < Base
+        def current
+          response = http.get("/sites/current")
+          Kentaa::Api::Responses::Site.new(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Kentaa
+  module Api
+    module Requests
+      class Teams < Base
+        include Kentaa::Api::Requests::All
+
+        def list(options = {})
+          response = http.get("/teams", options)
+          Kentaa::Api::Responses::Teams.new(response)
+        end
+
+        def get(id)
+          response = http.get("/teams/#{id}")
+          Kentaa::Api::Responses::Team.new(response)
+        end
+      end
+    end
+  end
+end