datacentred 0.1.1pre → 1.1.1

data/lib/datacentred/request/usage.rb

@@ -1,7 +1,16 @@
 module Datacentred
   module Request
+    # RESTful API requests for the usage endpoints.
     class Usage < Base
-
+      # Retrieve account usage data for a given year/month.
+      #
+      #   GET /api/usage/2017/9
+      #
+      # @param [Integer] year The year.
+      # @param [Integer] month The month.
+      # @raise [Errors::NotFound] Raised if no usage data found for given year/month pair.
+      # @raise [Errors::Unauthorized] Raised if credentials aren't valid.
+      # @return [Hash] Usage for given year/month pair.
       def self.show(year, month)
         get("usage/#{year}/#{month}")
       end

data/lib/datacentred/request/users.rb

@@ -1,25 +1,68 @@
 module Datacentred
   module Request
+    # RESTful API requests for the user endpoints.
     class Users < Base
+      class << self
+        # Create a new user.
+        #
+        #   POST /api/users
+        #
+        # @param [Hash] params User attributes.
+        # @raise [Errors::UnprocessableEntity] Raised if validations fail for the supplied attributes.
+        # @raise [Errors::Unauthorized] Raised if credentials aren't valid.
+        # @return [Hash] New user.
+        def create(params)
+          post('users', 'user' => params)['user']
+        end
 
-      def self.create(payload={})
-        post('users', payload.to_json)['user']
-      end
+        # List all available users.
+        #
+        #   GET /api/users
+        #
+        # @raise [Errors::Unauthorized] Raised if credentials aren't valid.
+        # @return [[Hash]] A collection of all users on this account.
+        def list
+          get('users')['users']
+        end
 
-      def self.list
-        get('users')['users']
-      end
+        # Find a user by unique ID.
+        #
+        #   GET /api/users/82fa8de8f09102cc
+        #
+        # @param [String] id The unique identifier for this user.
+        # @raise [Errors::NotFound] Raised if the user couldn't be found.
+        # @raise [Errors::Unauthorized] Raised if credentials aren't valid.
+        # @return [Hash] The user, if it exists.
+        def show(id)
+          get("users/#{id}")['user']
+        end
 
-      def self.show(id)
-        get("users/#{id}")['user']
-      end
-
-      def self.update(id, payload)
-        put("users/#{id}", payload.to_json)['user']
-      end
+        # Update a user by unique ID.
+        #
+        #   PUT /api/users/82fa8de8f09102cc
+        #
+        # @param [String] id The unique identifier for this user.
+        # @param [Hash] params User attributes.
+        # @raise [Errors::UnprocessableEntity] Raised if validations fail for the supplied attributes.
+        # @raise [Errors::NotFound] Raised if the user couldn't be found.
+        # @raise [Errors::Unauthorized] Raised if credentials aren't valid.
+        # @return [Hash] The updated user.
+        def update(id, params)
+          put("users/#{id}", 'user' => params)['user']
+        end
 
-      def self.destroy(id)
-        delete("users/#{id}")
+        # Permanently remove the specified user.
+        #
+        #   DELETE /api/users/82fa8de8f09102cc
+        #
+        # @param [String] id The unique identifier for this user.
+        # @raise [Errors::NotFound] Raised if the user couldn't be found.
+        # @raise [Errors::UnprocessableEntity] Raised if validations fail for the specified user.
+        # @raise [Errors::Unauthorized] Raised if credentials aren't valid.
+        # @return [nil] Confirms the user was destroyed.
+        def destroy(id)
+          delete("users/#{id}")
+        end
       end
     end
   end

data/lib/datacentred/request/versions.rb

@@ -1,7 +1,19 @@
 module Datacentred
   module Request
+    # RESTful API requests for the versions endpoint.
+    #
+    #   This model does not require authentication.
+    #
+    # An API version may be:
+    # * *CURRENT* - The latest supported version.
+    # * *SUPPORTED* - A supported older version.
+    # * *DEPRECATED* - Currently supported but soon to be retired.
     class Versions < Base
-
+      # List all available API versions
+      #
+      #   GET /api
+      #
+      # @return [[Hash]] Currently available versions of the API.
       def self.list
         get("/api")['versions']
       end

data/lib/datacentred/response.rb

@@ -1,12 +1,16 @@
 module Datacentred
+  # A response from the API server.
   class Response
-
     attr_reader :body, :status
 
+    # A response from the API server, initialized with A Faraday HTTP Response.
+    #
+    # @param [Faraday::Response] server_response A response object returned from Faraday.
+    # @raise [Errors::Error] Raised if response isn't a 2xx status code.
     def initialize(server_response)
       @body = JSON.parse server_response.body rescue nil
       @status = server_response.status
-      Error.raise_unless_successful(status, @body)
+      Errors.raise_unless_successful(status, @body)
     end
   end
 end

data/test/integration/authorization_test.rb

@@ -0,0 +1,30 @@
+require_relative '../test_helper'
+
+module Datacentred
+  class AuthorizationIntegrationTest < Minitest::Test
+    def test_account_not_authorized
+      VCR.use_cassette "not_authorized" do
+        assert_raises Errors::Unauthorized do
+          Datacentred::Project.all
+        end
+      end
+    end
+
+    def test_manually_setting_credentials
+      Datacentred.access_key = "foo"
+      assert_equal "foo", Datacentred.access_key
+      Datacentred.secret_key = "bar"
+      assert_equal "bar", Datacentred.secret_key
+    end
+
+    def test_catch_all_error
+      # VCR edited to return HTTP 418
+      VCR.use_cassette "unexpected_error" do
+        error = assert_raises Datacentred::Errors::Error do
+          Datacentred::Project.all
+        end
+        assert_equal "Error 418: Im a teapot.", error.message
+      end
+    end
+  end
+end

data/test/integration/projects_test.rb

@@ -3,8 +3,8 @@ 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"}}
+      @params_with_new_name = {name: "new_project_name"}
+      @create_params        = {name: "test_new_project"}
       @user_id              = "user_id"
       @project_id           = 'project_id1'
       @project_id2          = 'project_id2'
@@ -28,7 +28,7 @@ module Datacentred
 
     def test_raises_not_found_if_project_doesnt_exist
       VCR.use_cassette('project_not_found') do
-        assert_raises(Datacentred::NotFoundError) do
+        assert_raises(Datacentred::Errors::NotFound) do
           @project = Datacentred::Project.find("unknown")
         end
       end
@@ -43,7 +43,7 @@ module Datacentred
 
     def test_raises_unprocessable_entity_if_failed_validation_for_create
       VCR.use_cassette('project_create_failed_validation') do
-        assert_raises(Datacentred::UnprocessableEntity) do
+        assert_raises(Datacentred::Errors::UnprocessableEntity) do
           Datacentred::Project.create(@create_params)
         end
       end
@@ -58,8 +58,8 @@ module Datacentred
 
     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
+        @params_with_used_name = {name: "foo"}
+        assert_raises(Datacentred::Errors::UnprocessableEntity) do
           @project = Datacentred::Project.update(@project_id2, @params_with_used_name)
         end
       end
@@ -67,7 +67,7 @@ module Datacentred
 
     def test_raises_not_found_if_cant_find_project_for_update
       VCR.use_cassette('project_update_not_found') do
-        assert_raises(Datacentred::NotFoundError) do
+        assert_raises(Datacentred::Errors::NotFound) do
           @project = Datacentred::Project.update("unknown", @params_with_new_name)
         end
       end
@@ -75,8 +75,8 @@ module Datacentred
 
     def test_delete_project
       VCR.use_cassette('delete_project') do
-        Datacentred::Project.remove(@project_id2)
-        assert_raises(Datacentred::NotFoundError) do
+        Datacentred::Project.destroy(@project_id2)
+        assert_raises(Datacentred::Errors::NotFound) do
           @project = Datacentred::Project.find(@project_id2)
         end
       end
@@ -98,7 +98,7 @@ module Datacentred
       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)
+        assert Datacentred::Project.add_user project_id: @project_id, user_id: @user_id
         @user_list = Datacentred::Project.users(@project_id)
         assert_equal @user_list.count, 2
       end
@@ -108,7 +108,7 @@ module Datacentred
       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)
+        assert Datacentred::Project.remove_user project_id: @project_id, user_id: @user_id
         @user_list = Datacentred::Project.users(@project_id)
         assert_equal @user_list.count, 1
       end

data/test/integration/roles_test.rb

@@ -3,14 +3,14 @@ require_relative '../test_helper'
 module Datacentred
   class RolesIntegrationTest < Minitest::Test
     def setup
-      @create_params1      = {"role" => {"name" => "New Role"}}
-      @create_params2      = {"role" => {"name" => "Historical Figures",
-                              "permissions" => ["usage.read","tickets.modify"]}}
-      @new_permissions     = {"role" => {"permissions" => ['usage.read',
-                              'roles.modify', 'roles.read']}}
-      @invalid_permissions = {"role" => {"name" => "Genghis Khan",
-                              "permissions" => ["fighting"]}}
-      @update_params       = {"role" => {"name" => "Administrator 2"}}
+      @create_params1      = {name: "New Role"}
+      @create_params2      = {name: "Historical Figures",
+                              permissions: ["usage.read","tickets.modify"]}
+      @new_permissions     = {permissions: ['usage.read',
+                              'roles.modify', 'roles.read']}
+      @invalid_permissions = {name: "Genghis Khan",
+                              permissions: ["fighting"]}
+      @update_params       = {name: "Administrator 2"}
       @user_id             = "06eacbafda355a927f50f304db3af132"
     end
 
@@ -49,7 +49,7 @@ module Datacentred
 
     def test_create_role_with_invalid_permissions
       VCR.use_cassette('create_role_with_invalid_permissions') do
-        assert_raises(Datacentred::UnprocessableEntity) do
+        assert_raises(Datacentred::Errors::UnprocessableEntity) do
           @role = Datacentred::Role.create(@invalid_permissions)
         end
       end
@@ -67,7 +67,7 @@ module Datacentred
     def test_update_role_with_invalid_permissions
       VCR.use_cassette('update_role_with_invalid_permissions') do
         @role = Datacentred::Role.create(@create_params1)
-        assert_raises(Datacentred::UnprocessableEntity) do
+        assert_raises(Datacentred::Errors::UnprocessableEntity) do
           Datacentred::Role.update(@role.id, @invalid_permissions)
         end
       end
@@ -77,8 +77,8 @@ module Datacentred
       VCR.use_cassette('delete_role') do
         @role = Datacentred::Role.create(@create_params1)
         assert Datacentred::Role.find(@role.id)
-        Datacentred::Role.delete(@role.id)
-        assert_raises(Datacentred::NotFoundError) do
+        Datacentred::Role.destroy(@role.id)
+        assert_raises(Datacentred::Errors::NotFound) do
           @role = Datacentred::Role.find(@role.id)
         end
       end
@@ -97,7 +97,7 @@ module Datacentred
         @role = Datacentred::Role.create(@create_params1)
         @user_list = Datacentred::Role.users(@role.id)
         assert_equal @user_list.count, 0
-        Datacentred::Role.add_user(@role.id, @user_id)
+        assert Datacentred::Role.add_user role_id: @role.id, user_id: @user_id
         @new_users_list = Datacentred::Role.users(@role.id)
         assert_equal @new_users_list.count, 1
         assert_equal @new_users_list.first.id, @user_id
@@ -107,10 +107,10 @@ module Datacentred
     def test_remove_user_from_role
       VCR.use_cassette('remove_user_from_role') do
         @role = Datacentred::Role.create(@create_params1)
-        Datacentred::Role.add_user(@role.id, @user_id)
+        assert Datacentred::Role.add_user role_id: @role.id, user_id: @user_id
         @user_list = Datacentred::Role.users(@role.id)
         assert_equal @user_list.count, 1
-        Datacentred::Role.remove_user(@role.id, @user_id)
+        assert Datacentred::Role.remove_user role_id: @role.id, user_id: @user_id
         @new_user_list = Datacentred::Role.users(@role.id)
         assert_equal @new_user_list.count, 0
       end
@@ -119,8 +119,8 @@ module Datacentred
     def test_remove_user_from_role_not_found
       VCR.use_cassette('remove_user_from_role_not_found') do
         @role = Datacentred::Role.create(@create_params1)
-        assert_raises(Datacentred::NotFoundError) do
-          Datacentred::Role.remove_user(@role.id, "unknown")
+        assert_raises(Datacentred::Errors::NotFound) do
+          Datacentred::Role.remove_user role_id: @role.id, user_id: "unknown"
         end
       end
     end

data/test/integration/usage_test.rb

@@ -2,21 +2,21 @@ require_relative '../test_helper'
 
 module Datacentred
   class UsageIntegrationTest < Minitest::Test
-
     def test_show_usage
       VCR.use_cassette('show_usage') do
-        @usage = Datacentred::Usage.show(2017, 07)
-        assert @usage.is_a? Array
-        assert @usage.first.name.is_a? String
-        assert @usage.first.id.is_a? String
-        assert @usage.first.usage.is_a? Hash
+        @usage = Datacentred::Usage.find(2017, 07)
+        assert @usage.last_updated_at.is_a? Time
+        assert @usage.projects.is_a? Array
+        assert @usage.projects.first.name.is_a? String
+        assert @usage.projects.first.id.is_a? String
+        assert_equal 0, @usage.projects.first.usage.ips.usage.first.value
       end
     end
 
     def test_raises_not_found_if_no_data
       VCR.use_cassette('usage_not_found') do
-        assert_raises(Datacentred::NotFoundError) do
-          @usage = Datacentred::Usage.show(2010, 07)
+        assert_raises(Datacentred::Errors::NotFound) do
+          @usage = Datacentred::Usage.find(2010, 07)
         end
       end
     end

data/test/integration/users_test.rb

@@ -2,17 +2,21 @@ require_relative '../test_helper'
 
 module Datacentred
   class UsersIntegrationTest < Minitest::Test
-
     def setup
-
-      @create_params_without_pass = {"user" => {"email" => "death@afterlife2.com"}}
-      @create_params              = {"user" => {"email" => "death@afterlife.com",
-                                      "password" => "melvin11", "first_name" => "Foo","last_name" => "Bar"}}
-      @create_params2             = {"user" => {"email" => "death2@afterlife2.com",
-                                      "password" => "melvin22"}}
+      @create_params_without_pass = {email: "death@afterlife2.com"}
+      @create_params              = {
+                                      email: "death@afterlife.com",
+                                      password: "melvin11",
+                                      first_name: "Foo",
+                                      last_name: "Bar"
+                                    }
+      @create_params2             = {
+                                      email: "death2@afterlife2.com",
+                                      password: "melvin22"
+                                    }
       @user_id                    = "bda96ae2c89347d5a059d663c153ec2a"
-      @update_params              = {"user" => {"first_name" => "Foo2"}}
-      @short_password             = {"user" => {"password" => "tiny"}}
+      @update_params              = {first_name: "Foo2"}
+      @short_password             = {password:   "tiny"}
     end
 
     def test_user_object_properties
@@ -50,7 +54,7 @@ module Datacentred
 
     def test_raises_not_found_if_cant_find_user
       VCR.use_cassette('user_show_not_found') do
-        assert_raises(Datacentred::NotFoundError) do
+        assert_raises(Datacentred::Errors::NotFound) do
           @user = Datacentred::User.find("unknown")
         end
       end
@@ -68,7 +72,7 @@ module Datacentred
 
     def test_raises_unprocessable_entity_if_failed_validation_for_create
       VCR.use_cassette('user_create_failed_validation') do
-        assert_raises(Datacentred::UnprocessableEntity) do
+        assert_raises(Datacentred::Errors::UnprocessableEntity) do
           @user = Datacentred::User.create(@create_params_without_pass)
         end
       end
@@ -85,7 +89,7 @@ module Datacentred
     def test_raises_unprocessable_entity_if_failed_validation_for_update
       VCR.use_cassette('user_update_failed_validation') do
         @user = Datacentred::User.create(@create_params)
-        assert_raises(Datacentred::UnprocessableEntity) do
+        assert_raises(Datacentred::Errors::UnprocessableEntity) do
           @user = Datacentred::User.update(@user.id, @short_password)
         end
       end
@@ -93,7 +97,7 @@ module Datacentred
 
     def test_raises_not_found_if_user_doesnt_exist
       VCR.use_cassette('user_update_not_found') do
-        assert_raises(Datacentred::NotFoundError) do
+        assert_raises(Datacentred::Errors::NotFound) do
           @user = Datacentred::User.update("unknown", @update_params)
         end
       end
@@ -102,8 +106,8 @@ module Datacentred
     def test_delete_user
       VCR.use_cassette('delete_user') do
         @user = Datacentred::User.create(@create_params)
-        Datacentred::User.delete(@user.id)
-        assert_raises(Datacentred::NotFoundError) do
+        Datacentred::User.destroy(@user.id)
+        assert_raises(Datacentred::Errors::NotFound) do
           @user = Datacentred::User.find(@user.id)
         end
       end
@@ -111,16 +115,16 @@ module Datacentred
 
     def test_raises_unprocessable_entity_if_failed_validation_for_delete
       VCR.use_cassette('user_delete_failed_validation') do
-        assert_raises(Datacentred::UnprocessableEntity) do
-          @user = Datacentred::User.delete("my_user_id")
+        assert_raises(Datacentred::Errors::UnprocessableEntity) do
+          @user = Datacentred::User.destroy("my_user_id")
         end
       end
     end
 
     def test_user_cant_be_deleted_if_not_found
       VCR.use_cassette('user_delete_not_found') do
-        assert_raises(Datacentred::NotFoundError) do
-          @user = Datacentred::User.delete("unknown")
+        assert_raises(Datacentred::Errors::NotFound) do
+          @user = Datacentred::User.destroy("unknown")
         end
       end
     end