authenticator-client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a69ccae84065fcba5e7cef9403baaaf1fe304467
-  data.tar.gz: 0af8c0a607f41f51f875d2868f853031565c767d
+  metadata.gz: cd9129412c0abea844885d8fe90ace9b3d54a979
+  data.tar.gz: 032fc0192b99e8c46778bff82b2463545dc7bccb
 SHA512:
-  metadata.gz: e0085a2d4bdfb54d1e55c2f4f8212eb0b6ba70da67e5fdb49e80f4ecea80b3c1e4d7af0e174b93c26f53de9a1a3d0b766e4d93b766648eb1e3b889a0cbdc5bb9
-  data.tar.gz: 57b4c784d33407da03c91c2405bfd38c81af6df12e416274c450fd91b89c672619da51dc10aedde9e86fa2f751d02055dcf45fe7d1f7ec45f42f9ad119099c49
+  metadata.gz: 29cf3f15a440e926218eb9a5be081250237ba7049149267780498c2b17651fb0c1c7053ad0207d94abc0912c0cae9d1f9476d20f267cb3ccf2b93ab8fcc3675b
+  data.tar.gz: e30fc2bb3983fc6be64aabf729535e38eb72209ed0529fa8c0e9aac581d46541c8b84c90a49e1f8c68ecade932a789beea74e2758d49e21467eaa80a122666ca

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+
+rvm:
+  - 2.1.0
+
+gemfile:
+  - Gemfile
+
+cache: bundler
+
+env:
+  matrix:
+    - TEST_SUITE="spec"
+
+
+before_script: "bundle update"
+
+script:
+  - bundle exec rake $TEST_SUITE
+
+notifications:
+  email: false

data/README.md

@@ -1,6 +1,12 @@
 # Authenticator::Client
+[![Build Status](https://travis-ci.org/johnmcconnell/authenticator-client.svg?branch=master)]
+(https://travis-ci.org/johnmcconnell/authenticator-client)
+[![Coverage
+Status](https://coveralls.io/repos/johnmcconnell/authenticator-client/badge.png?branch=master)](https://coveralls.io/r/johnmcconnell/authenticator-client?branch=master)
 
-TODO: Write a gem description
+## Description
+This gem is designed to be used with
+[Account Authenticator](https://account-authenticator.herokuapp.com/)
 
 ## Installation
 
@@ -20,7 +26,70 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Creating a client:
+
+```
+config = {
+  api_key: 'api_key',
+  api_password: 'api_password',
+  host: 'http://account-authenticator.herokuapp.com'
+}
+
+Authenticator::Client.register_config(:config_key, config)
+Authenticator::Client.new(:config_key)
+
+```
+
+### Creating an account:
+
+```
+client.create(Account.new(username, password))
+#=> '{
+  "id":6,
+  "username":"new_username",
+  "created_at":"2015-01-04T20:36:28.339Z",
+  "updated_at":"2015-01-04T20:36:28.339Z"
+}'
+```
+
+### Authenticating an account:
+
+```
+client.authenticate(account)
+#=> '{"authenticated":true}'
+```
+
+### Reading accounts:
+
+```
+client.all
+#=> '{"accounts":[
+  { "id":6,
+    "username":"new_username",
+    "created_at":"2015-01-04T20:36:28.339Z",
+    "updated_at":"2015-01-04T20:36:28.339Z" }
+]}'
+
+```
+
+### Updating an account:
+
+```
+client.update(id, account)
+#=> '{
+  "id":7,
+  "username":"new_username_1",
+  "created_at":"2015-01-04T20:36:28.949Z",
+  "updated_at":"2015-01-04T20:36:28.949Z"
+}'
+```
+
+### Deleting an account:
+
+```
+client.destroy(id)
+#=> '{"id":10}'
+```
 
 ## Contributing
 

data/authenticator-client.gemspec

@@ -19,8 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'rest-client', '~> 1.7.2'
+  spec.add_dependency 'json_client', '~> 0.0.1'
+
+  spec.add_development_dependency "simplecov", "~> 0.8.0"
+  spec.add_development_dependency "coveralls", "~> 0.7.0"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-collection_matchers"

data/lib/authenticator/client/account.rb

@@ -15,6 +15,7 @@ module Authenticator
           }
         }
       end
+      alias_method :to_h, :to_params
     end
   end
 end

data/lib/authenticator/client/authenticate_response.rb

@@ -0,0 +1,15 @@
+require 'json_client'
+
+module Authenticator
+  module Client
+    class AuthenticateResponse < JsonClient::BaseResponses::Response
+      def initialize(body, code)
+        super
+      end
+
+      def auth_success?
+        json['authenticated'] == true
+      end
+    end
+  end
+end

data/lib/authenticator/client/base.rb

@@ -1,91 +1,32 @@
 require 'rest_client'
+require 'json_client'
+require_relative 'authenticate_response'
 
 module Authenticator
   module Client
-    class Base
-      attr_reader :api_key, :api_password, :host
-
+    class Base < JsonClient::Base
       def initialize(config)
-        @api_key = config[:api_key]
-        @api_password = config[:api_password]
-        @host = config[:host]
-        validate_variables
-      end
-
-      def all
-        uri = account_path
-        RestClient.get uri, params: auth_params
-      end
-
-      def show(id)
-        uri = account_path(id)
-        RestClient.get uri, params: auth_params
-      end
-
-      def create(account)
-        uri = account_path
-        RestClient.post(
-          uri,
-          auth_params.merge(account.to_params).to_json,
-          content_type: :json,
-          accept: :json
+        super(
+          JsonClient::Pather.new(config[:host], 'api/v1', 'accounts'),
+          config
         )
       end
 
       def authenticate(account)
         uri = authenticate_path
-        RestClient.post(
-          uri,
-          auth_params.merge(account.to_params).to_json,
-          content_type: :json,
-          accept: :json
-        )
-      end
-
-      def update(id, account)
-        uri = account_path(id)
-        RestClient.put(
+        response = RestClient.post(
           uri,
-          auth_params.merge(account.to_params).to_json,
+          auth_params.merge(account.to_h).to_json,
           content_type: :json,
           accept: :json
         )
-      end
-
-      def destroy(id)
-        uri = account_path(id)
-        RestClient.delete(
-          uri, params: auth_params
-        )
+        AuthenticateResponse.new(response.body, response.code)
       end
 
       protected
 
       def authenticate_path
-        "#{host}/api/v1/authentications/authenticate"
-      end
-
-      def account_path(id = nil)
-        if id.nil?
-          "#{host}/api/v1/accounts"
-        else
-          "#{host}/api/v1/accounts/#{id}"
-        end
-      end
-
-      def auth_params
-        {
-          api_key: api_key,
-          api_password: api_password
-        }
-      end
-
-      private
-
-      def validate_variables
-        fail 'host must be set' if host.nil?
-        fail 'api_key must be set' if api_key.nil?
-        fail 'api_password must be set' if api_key.nil?
+        "#{pather.host}/api/v1/authentications/authenticate"
       end
     end
   end

data/lib/authenticator/client/version.rb

@@ -1,5 +1,5 @@
 module Authenticator
   module Client
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/authenticator/client/base_spec.rb

@@ -41,7 +41,7 @@ describe Authenticator::Client::Base do
   describe '#all' do
     it 'fetches all the accounts' do
       VCR.use_cassette('all_success') do
-        response = JSON.parse(subject.all)
+        response = subject.index.json
 
         expect(response['accounts']).not_to be nil
       end
@@ -51,11 +51,10 @@ describe Authenticator::Client::Base do
   describe '#authenticate' do
     it 'creates an account' do
       VCR.use_cassette('authenticate_success') do
-        response = JSON.parse(
-          subject.authenticate(account)
-        )
+        response = subject.authenticate(account)
 
-        expect(response['authenticated']).to eq true
+        expect(response.json['authenticated']).to eq true
+        expect(response.auth_success?).to eq true
       end
     end
   end
@@ -63,9 +62,7 @@ describe Authenticator::Client::Base do
   describe '#create' do
     it 'creates an account' do
       VCR.use_cassette('create_success') do
-        response = JSON.parse(
-          subject.create(account)
-        )
+        response = subject.create(account).json
 
         expect(response['username']).to eq 'new_username'
         expect(response['id']).not_to be nil
@@ -78,9 +75,12 @@ describe Authenticator::Client::Base do
   describe '#show' do
     it 'fetches the account' do
       VCR.use_cassette('show_success') do
-        response = JSON.parse(subject.show(6))
+        response = subject.show(6).json
 
         expect(response['username']).to eq 'new_username'
+        expect(response['id']).to be 6
+        expect(response['created_at']).to eq '2015-01-04T20:36:28.339Z'
+        expect(response['updated_at']).to eq '2015-01-04T20:36:28.339Z'
       end
     end
   end
@@ -88,8 +88,8 @@ describe Authenticator::Client::Base do
   describe '#update' do
     it 'updates the account' do
       VCR.use_cassette('update_success') do
-        id = JSON.parse(subject.create(new_account))['id']
-        response = JSON.parse(subject.update(id, updated_account))
+        id = subject.create(new_account).json['id']
+        response = subject.update(id, updated_account).json
 
         expect(response['username']).to eq updated_account.username
         expect(response['id']).to eq id
@@ -100,8 +100,8 @@ describe Authenticator::Client::Base do
   describe '#destroy' do
     it 'destroys the account' do
       VCR.use_cassette('destroy_success') do
-        id = JSON.parse(subject.create(destroy_account))['id']
-        response = JSON.parse(subject.destroy(id))
+        id = subject.create(destroy_account).json['id']
+        response = subject.destroy(id).json
 
         expect(response['id']).to eq id
       end

data/spec/authenticator/client_spec.rb

@@ -21,7 +21,7 @@ describe Authenticator::Client do
     it 'registers a configuration to be used when invoked with ::new' do
       described_class.register_config(:test, config)
       client = described_class.new(:test)
-      expect(client.host).to eq config[:host]
+      expect(client.pather.host).to eq config[:host]
       expect(client.api_key).to eq config[:api_key]
       expect(client.api_password).to eq config[:api_password]
     end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 require 'authenticator/client'
 require 'vcr'
+require 'coveralls'
+
+Coveralls.wear!
 
 class SpecHelper
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authenticator-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - johnmcconnell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-05 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -25,19 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.7.2
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: json_client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -123,6 +152,7 @@ files:
 - authenticator-client.gemspec
 - lib/authenticator/client.rb
 - lib/authenticator/client/account.rb
+- lib/authenticator/client/authenticate_response.rb
 - lib/authenticator/client/base.rb
 - lib/authenticator/client/version.rb
 - spec/authenticator/client/base_spec.rb