distant 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04f23a0783899b668d29d4c7d9b69094bba82ab7
-  data.tar.gz: c4ec21cd7156223d2913e623c02beb75acc3260d
+  metadata.gz: 11000ca2e279a5ab60f8848ad83ff73a9e412752
+  data.tar.gz: 74f397589688443544dc0dc61c5a073bc8035f4b
 SHA512:
-  metadata.gz: 8814fe8479e43c40afc77f87cf26f7d12531ccad28b0ff1d501a67ac2b203d25e7f4ef0a623adb68199235f606aafafb8d98e4723c57dbccbc16da29d06082a1
-  data.tar.gz: 2f74f38442f84652a3589284daff9caf43545ddf70075960a09f7da3de347f5b88ba5b8357da2d62e8c356946d54f5380133910892e293df53609df450423fc1
+  metadata.gz: de50b26f9fe809c513c168a9877b6ef097a01b37b0e96ca1f164e353c84d673e41fef56e9658f6e5e5daddea45bbf0e2ac4ccaaa7cc4f017b623679349e26aba
+  data.tar.gz: 7ce0dc782fc5d42b1b09dc12840cb272a1573365230c346e6b7f74082a01867fca12f2a62568179b97ad04de9e5fa368a20d2d33b8834dfc954ab39763597f19

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    distant (0.1.3)
+    distant (0.1.4)
       activesupport
       httparty
 

data/distant.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name        = 'distant'
-  spec.version     = '0.1.3'
+  spec.version     = '0.1.4'
   spec.authors     = ['John Drago']
   spec.email       = 'jdrago.999@gmail.com'
   spec.homepage    = 'https://github.com/distant/distant'

data/lib/distant/base.rb

@@ -33,7 +33,7 @@ module Distant
       end
 
       def connection
-        @@connection ||= Distant::Connection.new( Distant.config )
+        @@connection ||= Distant::Connection.configure( Distant.config )
       end
 
       def has_many_rels
@@ -111,7 +111,7 @@ module Distant
           parsed = JSON.parse(response.body, symbolize_names: true)
           parsed.is_a?(Array) ?
             parsed.map{ |item| translator.translate_from_hash(item) }
-            : translator.translate_from_hash(item)
+            : translator.translate_from_hash(parsed)
         else
           raise Distant::ApiError.new response
         end

data/lib/distant/config.rb

@@ -1,12 +1,13 @@
 
 module Distant
   class Config
-    attr_accessor :base_uri, :auth_header_generator, :default_header_generator
+    attr_accessor :base_uri, :debug, :auth_header_generator, :default_header_generator
 
     def initialize
       # Default just returns an empty hash:
       self.auth_header_generator = Proc.new{ {} }
       self.default_header_generator = Proc.new{ {} }
+      self.debug = false
     end
 
     def set_authentication_headers_with(&block)

data/lib/distant/connection.rb

@@ -3,11 +3,13 @@ module Distant
   class Connection
     include HTTParty
 
-    attr_accessor :config
-    def initialize(config)
+    def self.configure(config)
       raise ArgumentError.new 'invalid config' unless config.is_a? Distant::Config
-      self.config = config
-      self.class.base_uri config.base_uri
+      self.base_uri config.base_uri
+      if config.debug
+        self.debug_output
+      end
+      self
     end
   end
 end

data/spec/client/base_spec.rb

@@ -88,7 +88,7 @@ describe Distant::Base do
     context 'when called' do
       context 'the first time' do
         before do
-          expect(Distant::Connection).to receive(:new).exactly(1).times
+          expect(Distant::Connection).to receive(:configure).exactly(1).times
         end
         it 'returns a new Distant::Connection' do
           Distant::BaseTest.connection
@@ -96,7 +96,7 @@ describe Distant::Base do
       end
       context 'subsequent times' do
         before do
-          expect(Distant::Connection).to receive(:new).exactly(1).times.and_call_original
+          expect(Distant::Connection).to receive(:configure).exactly(1).times.and_call_original
         end
         it 'returns the same Distant::Connection' do
           first_connection = Distant::BaseTest.connection
@@ -121,7 +121,7 @@ describe Distant::Base do
         expect(Distant::BaseTest).to receive(:preprocess_response){ [{id: 123}] }
       end
       it 'makes a GET request with the correct route' do
-        expect_any_instance_of(Distant::Connection).to receive(:get).with(@route, {})
+        expect(Distant::Connection).to receive(:get).with(@route, {})
         # Finally:
         Distant::BaseTest.all
       end
@@ -131,7 +131,7 @@ describe Distant::Base do
         expect(Distant::BaseTest).to receive(:preprocess_response){ {id: 123} }
       end
       it 'makes a GET request with the correct route' do
-        expect_any_instance_of(Distant::Connection).to receive(:get).with(@single_route.gsub(':id', '123'), {})
+        expect(Distant::Connection).to receive(:get).with(@single_route.gsub(':id', '123'), {})
         # Finally:
         Distant::BaseTest.find(id: 123)
       end
@@ -151,7 +151,7 @@ describe Distant::Base do
         expect(Distant::BaseTest).to receive(:preprocess_response){ [{base_test_id: 123, id: 456}]}
       end
       it 'makes a GET request with the correct route' do
-        expect_any_instance_of(Distant::Connection).to receive(:get).with('/base/123/tests', {})
+        expect(Distant::Connection).to receive(:get).with('/base/123/tests', {})
         result = Distant::BaseTest.new(id: 123).sub_tests
         expect(result.first).to be_a Distant::SubTest
       end
@@ -171,7 +171,7 @@ describe Distant::Base do
         expect(Distant::SubTest).to receive(:preprocess_response){ {id: 123, name: 'foo'}}
       end
       it 'makes a GET request with the correct route' do
-        expect_any_instance_of(Distant::Connection).to receive(:get).with('/base/123', {})
+        expect(Distant::Connection).to receive(:get).with('/base/123', {})
         result = Distant::SubTest.new(id: 456, base_test_id: 123).base_test
         expect(result).to be_a Distant::BaseTest
       end
@@ -196,19 +196,33 @@ describe Distant::Base do
         end
         context 'and the response' do
           context 'is valid JSON' do
-            before do
-              @response_data = [
-                {id: 123, name: 'Test'},
-                {fooId: 456, nickName: 'Testy McTesterson'}
-              ]
-              @expected_data = [
-                {id: 123, name: 'Test'},
-                {foo_id: 456, nick_name: 'Testy McTesterson'}
-              ]
-              expect(@response).to receive(:body){ @response_data.to_json }
-            end
-            it 'returns the parsed JSON response' do
-              expect(Distant::BaseTest.preprocess_response(@response)).to eq @expected_data
+            context 'in the form of' do
+              context 'an Array of Objects' do
+                before do
+                  @response_data = [
+                    {id: 123, name: 'Test'},
+                    {fooId: 456, nickName: 'Testy McTesterson'}
+                  ]
+                  @expected_data = [
+                    {id: 123, name: 'Test'},
+                    {foo_id: 456, nick_name: 'Testy McTesterson'}
+                  ]
+                  expect(@response).to receive(:body){ @response_data.to_json }
+                end
+                it 'returns the parsed JSON response' do
+                  expect(Distant::BaseTest.preprocess_response(@response)).to eq @expected_data
+                end
+              end
+              context 'an Object' do
+                before do
+                  @response_data = {fooId: 456, nickName: 'Testy McTesterson'}
+                  @expected_data = {foo_id: 456, nick_name: 'Testy McTesterson'}
+                  expect(@response).to receive(:body){ @response_data.to_json }
+                end
+                it 'returns the parsed JSON response' do
+                  expect(Distant::BaseTest.preprocess_response(@response)).to eq @expected_data
+                end
+              end
             end
           end
           context 'is not valid JSON' do

data/spec/client/connection_spec.rb

@@ -1,16 +1,18 @@
 require 'spec_helper'
 
 describe Distant::Connection do
-  describe 'initialization' do
+  describe '.configure' do
     context 'when a Distant::Config object' do
       context 'is provided' do
-        it 'returns a new Distant::Connection object' do
-          expect(described_class.new(Distant::Config.new)).to be_a described_class
+        it 'does not raise an exception' do
+          config = Distant::Config.new
+          config.debug = true
+          expect{described_class.configure(config)}.not_to raise_error
         end
       end
       context 'is not provided' do
         it 'raises an exception' do
-          expect{described_class.new('a string')}.to raise_error ArgumentError
+          expect{described_class.configure('a string')}.to raise_error ArgumentError
         end
       end
     end

data/spec/client/translator_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe Distant::Translator do
+  describe 'initialize' do
+    before do
+      @translator = described_class.new
+    end
+    it 'sets default from/to translators' do
+      expect(@translator.from_hash_translator).to be_a Proc
+      expect(@translator.to_hash_translator).to be_a Proc
+    end
+  end
+
+  describe '#translate_from_hash(hash)' do
+    before do
+      @translator = described_class.new
+      @translator.from_hash do |hash|
+        secret = hash[:secret]
+        {foo: secret}
+      end
+    end
+    it 'uses the supplied translation block' do
+      my_secret = SecureRandom.uuid
+      result = @translator.translate_from_hash(secret: my_secret)
+      expect(result).to eq(foo: my_secret)
+    end
+  end
+  describe '#translate_to_hash(obj)' do
+    before do
+      @translator = described_class.new
+      @translator.to_hash do |hash|
+        secret = hash[:secret]
+        {foo: secret}
+      end
+    end
+    it 'uses the supplied translation block' do
+      my_secret = SecureRandom.uuid
+      result = @translator.translate_to_hash(secret: my_secret)
+      expect(result).to eq(foo: my_secret)
+    end
+  end
+  describe '#from_hash(&block)' do
+    before do
+      @translator = described_class.new
+      @secret = SecureRandom.uuid
+      @translator.from_hash do
+        @secret
+      end
+    end
+    it 'sets the block as the from_hash_translator' do
+      expect(@translator.from_hash_translator.call).to eq @secret
+    end
+  end
+  describe '#to_hash(&block)' do
+    before do
+      @translator = described_class.new
+      @secret = SecureRandom.uuid
+      @translator.to_hash do
+        @secret
+      end
+    end
+    it 'sets the block as the to_hash_translator' do
+      expect(@translator.to_hash_translator.call).to eq @secret
+    end
+  end
+  describe '#recursive_underscore(thing)' do
+    context 'when given' do
+      before do
+        @translator = described_class.new
+      end
+      context 'an Array of hashes' do
+        before do
+          @data = [{'fooBar' => 'baz'}]
+        end
+        it 'calls recursive_underscore on all elements in the array' do
+          expect(@translator.recursive_underscore(@data)).to eq([{foo_bar: 'baz'}])
+        end
+      end
+      context 'a Hash' do
+        before do
+          @data = {'fooBar' => 'baz'}
+        end
+        it 'underscores the keys in the hash' do
+          expect(@translator.recursive_underscore(@data)).to eq(foo_bar: 'baz')
+        end
+      end
+      context 'anything else' do
+        before do
+          @data = 'Hello, World'
+        end
+        it 'returns the thing as-is' do
+          expect(@translator.recursive_underscore(@data)).to eq(@data)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: distant
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - John Drago
@@ -159,6 +159,7 @@ files:
 - spec/client/config_spec.rb
 - spec/client/connection_spec.rb
 - spec/client/module_spec.rb
+- spec/client/translator_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/distant/distant
 licenses: []
@@ -188,4 +189,5 @@ test_files:
 - spec/client/config_spec.rb
 - spec/client/connection_spec.rb
 - spec/client/module_spec.rb
+- spec/client/translator_spec.rb
 - spec/spec_helper.rb