datacentred 0.1.0pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45b1b54675b4997ad636db5f4187e369216dec7b
+  data.tar.gz: 1c56568e101427d1b354bcc7511476a60640b826
+SHA512:
+  metadata.gz: 576873f9b1b66463e9643ff2ba5ccd844aeb4e48d071cbf23224c04ec27d1f7dad235ae871aa2796b629fd93f04586d75ebbb5bb02d046a91ed4e7435f2f346e
+  data.tar.gz: ef8bbc569d77ff1c2f644ee1452f75475cc90a0854250326edda3fb82606dbf17325c0acacda4eabba798e8f23eb6ccd879e61f74e30bd13f7f1c1ec1c608966

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in datacentred.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    datacentred (0.1.0)
+      faraday (~> 0.9.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    minitest (5.3.5)
+    multipart-post (2.0.0)
+    public_suffix (3.0.0)
+    safe_yaml (1.0.4)
+    vcr (2.8.0)
+    webmock (1.8.11)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  datacentred!
+  minitest (~> 5.3.1)
+  vcr (~> 2.8.0)
+  webmock (~> 1.8.0)
+
+BUNDLED WITH
+   1.15.1

data/README.md

@@ -0,0 +1,2 @@
+# datacentred-api-ruby
+Gem wrapper for Datacentred API.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/circle.yml

@@ -0,0 +1,5 @@
+machine:
+  timezone:
+    Europe/London
+  ruby:
+    version: 2.3.1

data/datacentred.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |gem|
+  gem.name = 'datacentred'
+  gem.version = '0.1.0pre'
+  gem.date = '2017-08-10'
+  gem.summary = 'datacentred'
+  gem.description = 'Gem wrapper for Datacentred API'
+  gem.authors = [ 'Eugenia Grieff', 'Sean Handley' ]
+  gem.email = 'megrieff@gmail.com'
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'https://github.com/datacentred/datacentred-api-ruby'
+  gem.license = 'BSD-3-Clause'
+
+  gem.required_ruby_version = '> 2.3'
+
+  # Runtime Dependencies
+  gem.add_runtime_dependency 'faraday', '~> 0.9.1'
+
+  # Development Dependencies
+  gem.add_development_dependency 'vcr', '~> 2.8.0'
+  gem.add_development_dependency 'webmock', '~> 1.8.0'
+  gem.add_development_dependency 'minitest', '~> 5.3.1'
+
+end

data/lib/datacentred/error.rb

@@ -0,0 +1,28 @@
+module Datacentred
+  class Error < StandardError
+    def self.raise_unless_successful(status, body)
+      return if status.to_s.start_with? "2" # 2xx
+      err = Datacentred::errors[status]
+      message = body&.fetch("errors")&.first&.fetch("detail")
+      if err
+        raise err, message
+      else
+        raise Datacentred::Error, "Error #{status}: #{message}"
+      end
+    end
+  end
+
+  class NotFoundError < StandardError; end
+  class UnprocessableEntity < StandardError; end
+  class Unauthorized < StandardError; end
+
+  private
+
+  def self.errors
+    {
+      401 => Unauthorized,
+      404 => NotFoundError,
+      422 => UnprocessableEntity
+    }
+  end
+end

data/lib/datacentred/model/project.rb

@@ -0,0 +1,44 @@
+module Datacentred
+  module Model
+    class Project < OpenStruct
+      def initialize(params)
+        params.delete("links") if params
+        params["created_at"] = Time.parse params["created_at"]
+        params["updated_at"] = Time.parse params["updated_at"]
+        super(params)
+      end
+
+      def self.all
+        Request::Projects.list.map{ |project| new(project) }
+      end
+
+      def self.find(id)
+        new Request::Projects.show(id)
+      end
+
+      def self.create(params)
+        new Request::Projects.create(params)
+      end
+
+      def self.update(id, params)
+        new Request::Projects.update(id, params)
+      end
+
+      def self.remove(id)
+        Request::Projects.destroy(id)
+      end
+
+      def self.users(id)
+        Request::Projects.list_users(id).map{ |user| new(user) }
+      end
+
+      def self.add_user(project_id, user_id)
+        Request::Projects.add_user(project_id, user_id)
+      end
+
+      def self.remove_user(project_id, user_id)
+        Request::Projects.remove_user(project_id, user_id)
+      end
+    end
+  end
+end

data/lib/datacentred/model/role.rb

@@ -0,0 +1,44 @@
+module Datacentred
+  module Model
+    class Role < OpenStruct
+      def initialize(params)
+        params.delete("links")
+        params["created_at"] = Time.parse params["created_at"]
+        params["updated_at"] = Time.parse params["updated_at"]
+        super(params)
+      end
+
+      def self.all
+        Request::Roles.list.map{|role| new(role) }
+      end
+
+      def self.find(id)
+        new Request::Roles.show(id)
+      end
+
+      def self.create(params)
+        new Request::Roles.create(params)
+      end
+
+      def self.update(id, params)
+        new Request::Roles.update(id, params)
+      end
+
+      def self.delete(id)
+        Request::Roles.destroy(id)
+      end
+
+      def self.users(id)
+        Request::Roles.list_users(id).map{|user| new(user) }
+      end
+
+      def self.add_user(role_id, user_id)
+        Request::Roles.add_user(role_id, user_id)
+      end
+
+      def self.remove_user(role_id, user_id)
+        Request::Roles.remove_user(role_id, user_id)
+      end
+    end
+  end
+end

data/lib/datacentred/model/usage.rb

@@ -0,0 +1,15 @@
+module Datacentred
+  module Model
+    class Usage < OpenStruct
+      def initialize(params)
+        params.delete("links")
+        # params["last_updated_at"] = Time.parse params["last_updated_at"]
+        super(params)
+      end
+
+      def self.show(year, month)
+        Request::Usage.show(year, month)["projects"].map{ |project| new(project) }
+      end
+    end
+  end
+end

data/lib/datacentred/model/user.rb

@@ -0,0 +1,32 @@
+module Datacentred
+  module Model
+    class User < OpenStruct
+      def initialize(params)
+        params.delete("links")
+        params["created_at"] = Time.parse params["created_at"]
+        params["updated_at"] = Time.parse params["updated_at"]
+        super(params)
+      end
+
+      def self.all
+        Request::Users.list.map { |user| new(user) }
+      end
+
+      def self.find(id)
+        new Request::Users.show(id)
+      end
+
+      def self.create(params)
+        new Request::Users.create(params)
+      end
+
+      def self.update(id, params)
+        new Request::Users.update(id, params)
+      end
+
+      def self.delete(id)
+        Request::Users.destroy(id)
+      end
+    end
+  end
+end

data/lib/datacentred/model/version.rb

@@ -0,0 +1,14 @@
+module Datacentred
+  module Model
+    class Version < OpenStruct
+      def initialize(params)
+        params.delete("links")
+        super(params)
+      end
+
+      def self.show
+        Request::Versions.list.map { |version| new(version) }
+      end
+    end
+  end
+end

data/lib/datacentred/request/base.rb

@@ -0,0 +1,46 @@
+module Datacentred
+  module Request
+    API_BASE_URL = 'https://my.datacentred.io'
+
+    class Base
+
+      def self.get(url, payload=nil)
+        response = Datacentred::Response.new(conn.get(url, payload))
+        response.body
+      end
+
+      def self.post(url, payload=nil)
+        response = Datacentred::Response.new(conn.post(url, payload))
+        response.body
+      end
+
+      def self.put(url, payload=nil)
+        response = Datacentred::Response.new(conn.put(url, payload))
+        response.body
+      end
+
+      def self.delete(url, payload=nil)
+        response = Datacentred::Response.new(conn.delete(url, payload))
+        response.body
+      end
+
+      private
+
+      def self.conn
+        Faraday.new(:url => API_BASE_URL) do |faraday|
+          faraday.path_prefix = "/api/"
+          faraday.request  :url_encoded
+          faraday.headers['Accept'] = "application/vnd.datacentred.api+json; version=1"
+          faraday.headers['Authorization'] = "Token token=#{credentials}"
+          faraday.headers['Content-Type'] = 'application/json'
+          faraday.adapter  Faraday.default_adapter
+        end
+      end
+
+      def self.credentials
+        "#{Datacentred.access_key}:#{Datacentred.secret_key}"
+      end
+
+    end
+  end
+end

data/lib/datacentred/request/projects.rb

@@ -0,0 +1,38 @@
+module Datacentred
+  module Request
+    class Projects < Base
+
+      def self.create(payload={})
+        post('projects', payload.to_json)['project']
+      end
+
+      def self.list
+        get('projects')['projects']
+      end
+
+      def self.show(id)
+        get("projects/#{id}")['project']
+      end
+
+      def self.update(id, payload={})
+        put("projects/#{id}", payload.to_json)['project']
+      end
+
+      def self.destroy(id)
+        delete("projects/#{id}")
+      end
+
+      def self.list_users(id)
+        get("projects/#{id}/users")['users']
+      end
+
+      def self.add_user(project_id, user_id)
+        put("projects/#{project_id}/users/#{user_id}")
+      end
+
+      def self.remove_user(project_id, user_id)
+        delete("projects/#{project_id}/users/#{user_id}")
+      end
+    end
+  end
+end

data/lib/datacentred/request/roles.rb

@@ -0,0 +1,38 @@
+module Datacentred
+  module Request
+    class Roles < Base
+
+      def self.create(payload={})
+        post('roles', payload.to_json)['role']
+      end
+
+      def self.list
+        get('roles')['roles']
+      end
+
+      def self.show(id)
+        get("roles/#{id}")['role']
+      end
+
+      def self.update(id, payload={})
+        put("roles/#{id}", payload.to_json)['role']
+      end
+
+      def self.destroy(id)
+        delete("roles/#{id}")
+      end
+
+      def self.list_users(role_id)
+        get("roles/#{role_id}/users")['users']
+      end
+
+      def self.add_user(role_id, user_id)
+        put("roles/#{role_id}/users/#{user_id}")
+      end
+
+      def self.remove_user(role_id, user_id)
+        delete("roles/#{role_id}/users/#{user_id}")
+      end
+    end
+  end
+end

data/lib/datacentred/request/usage.rb

@@ -0,0 +1,10 @@
+module Datacentred
+  module Request
+    class Usage < Base
+
+      def self.show(year, month)
+        get("usage/#{year}/#{month}")
+      end
+    end
+  end
+end

data/lib/datacentred/request/users.rb

@@ -0,0 +1,26 @@
+module Datacentred
+  module Request
+    class Users < Base
+
+      def self.create(payload={})
+        post('users', payload.to_json)['user']
+      end
+
+      def self.list
+        get('users')['users']
+      end
+
+      def self.show(id)
+        get("users/#{id}")['user']
+      end
+
+      def self.update(id, payload)
+        put("users/#{id}", payload.to_json)['user']
+      end
+
+      def self.destroy(id)
+        delete("users/#{id}")
+      end
+    end
+  end
+end

data/lib/datacentred/request/versions.rb

@@ -0,0 +1,10 @@
+module Datacentred
+  module Request
+    class Versions < Base
+
+      def self.list
+        get("/api")['versions']
+      end
+    end
+  end
+end

data/lib/datacentred/response.rb

@@ -0,0 +1,12 @@
+module Datacentred
+  class Response
+
+    attr_reader :body, :status
+
+    def initialize(server_response)
+      @body = JSON.parse server_response.body rescue nil
+      @status = server_response.status
+      Error.raise_unless_successful(status, @body)
+    end
+  end
+end

data/lib/datacentred.rb

@@ -0,0 +1,40 @@
+require 'faraday'
+require 'json'
+
+module Datacentred
+  require_relative 'datacentred/response'
+  require_relative 'datacentred/error'
+  require_relative 'datacentred/model/user'
+  require_relative 'datacentred/model/project'
+  require_relative 'datacentred/model/role'
+  require_relative 'datacentred/model/usage'
+  require_relative 'datacentred/model/version'
+  require_relative 'datacentred/request/base'
+  require_relative 'datacentred/request/projects'
+  require_relative 'datacentred/request/users'
+  require_relative 'datacentred/request/roles'
+  require_relative 'datacentred/request/usage'
+  require_relative 'datacentred/request/versions'
+
+  def self.access_key
+    @@access_key ||= ENV['DATACENTRED_ACCESS']
+  end
+
+  def self.access_key=(val)
+    @@access_key = val
+  end
+
+  def self.secret_key
+    @@secret_key ||= ENV['DATACENTRED_SECRET']
+  end
+
+  def self.secret_key=(val)
+    @@secret_key = val
+  end
+
+  User = Model::User
+  Project = Model::Project
+  Role = Model::Role
+  Usage = Model::Usage
+  Version = Model::Version
+end

data/test/integration/projects_test.rb

@@ -0,0 +1,117 @@
+require_relative '../test_helper'
+
+module Datacentred
+  class ProjectsIntegrationTest < Minitest::Test
+    def setup
+      @params_with_new_name = {"project" =>{"name" => "new_project_name"}}
+      @create_params        = {"project" => {"name" => "test_new_project"}}
+      @user_id              = "user_id"
+      @project_id           = 'project_id1'
+      @project_id2          = 'project_id2'
+    end
+
+    def test_list_projects
+      VCR.use_cassette('list_projects') do
+        @projects = Datacentred::Project.all
+        assert_equal 1, @projects.count
+        @project = @projects.first
+        assert @project.id
+      end
+    end
+
+    def test_show_project
+      VCR.use_cassette('show_project') do
+        @project = Datacentred::Project.find(@project_id)
+        assert_equal @project.name, "foo_bar_primary"
+      end
+    end
+
+    def test_raises_not_found_if_project_doesnt_exist
+      VCR.use_cassette('project_not_found') do
+        assert_raises(Datacentred::NotFoundError) do
+          @project = Datacentred::Project.find("unknown")
+        end
+      end
+    end
+
+    def test_create_project
+      VCR.use_cassette('create_project') do
+        @new_project = Datacentred::Project.create(@create_params)
+        assert_equal @new_project.name, "test_new_project"
+      end
+    end
+
+    def test_raises_unprocessable_entity_if_failed_validation_for_create
+      VCR.use_cassette('project_create_failed_validation') do
+        assert_raises(Datacentred::UnprocessableEntity) do
+          Datacentred::Project.create(@create_params)
+        end
+      end
+    end
+
+    def test_update_project
+      VCR.use_cassette('update_project') do
+        @updated_project = Datacentred::Project.update(@project_id2, @params_with_new_name)
+        assert_equal @updated_project.name, "test_new_project_name"
+      end
+    end
+
+    def test_raises_unprocessable_entity_if_failed_validation_for_update
+      VCR.use_cassette('project_update_failed_validation') do
+        @params_with_used_name = {"project" => {"name" => "foo"}}
+        assert_raises(Datacentred::UnprocessableEntity) do
+          @project = Datacentred::Project.update(@project_id2, @params_with_used_name)
+        end
+      end
+    end
+
+    def test_raises_not_found_if_cant_find_project_for_update
+      VCR.use_cassette('project_update_not_found') do
+        assert_raises(Datacentred::NotFoundError) do
+          @project = Datacentred::Project.update("unknown", @params_with_new_name)
+        end
+      end
+    end
+
+    def test_delete_project
+      VCR.use_cassette('delete_project') do
+        Datacentred::Project.remove(@project_id2)
+        assert_raises(Datacentred::NotFoundError) do
+          @project = Datacentred::Project.find(@project_id2)
+        end
+      end
+    end
+
+    def test_list_project_users
+      VCR.use_cassette('list_project_users') do
+        @user_list = Datacentred::Project.users(@project_id)
+        assert_equal @user_list.count, 2
+        @user = @user_list.first
+        assert @user.id
+        assert @user.first_name
+        assert @user.last_name
+        assert @user.email
+      end
+    end
+
+    def test_add_user_to_project
+      VCR.use_cassette('add_user_to_project') do
+        @user_list = Datacentred::Project.users(@project_id)
+        assert_equal @user_list.count, 1
+        Datacentred::Project.add_user(@project_id, @user_id)
+        @user_list = Datacentred::Project.users(@project_id)
+        assert_equal @user_list.count, 2
+      end
+    end
+
+    def test_remove_user_from_project
+      VCR.use_cassette('remove_user_from_project') do
+        @user_list = Datacentred::Project.users(@project_id)
+        assert_equal @user_list.count, 2
+        Datacentred::Project.remove_user(@project_id, @user_id)
+        @user_list = Datacentred::Project.users(@project_id)
+        assert_equal @user_list.count, 1
+      end
+    end
+  end
+end