distant 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15b97b720febe3eda9c6c84b571b546f466f3aac
-  data.tar.gz: 6f64bff4470a4c4c21eeab79c12f8106a9b1407b
+  metadata.gz: 730b8a2b639f0f0cac7f5174658e69f64eafb634
+  data.tar.gz: 39258025d76ebfab214f398130f36872f2fa8971
 SHA512:
-  metadata.gz: 1e4847b3fd9615ed48963c20f1691c61c2bd5b603c8a9e173628705769a977d599d8e7865024d2ecfeee326627bb8afd94e09d9b8b8a44436e64da41bcd8d21c
-  data.tar.gz: 2ffabbfa4affb8d99054eaa0893a555ef80acbfa080c869ef5ce54884e251da3f8fd23fe76ee9d3c6a276bbb3942cd7114a70337a8a99553af7e919b29431727
+  metadata.gz: c66735d6409692b5c80e6c74a00a07048b18bf6f76ff9e54990b8cfc67ed016d11122e34622741c9864a4e72521d558e792be1c77ee3208f9b43d962cf78dc52
+  data.tar.gz: f61b848ee6324101a6514aeebfbf1eaca88e45127d3798de1e8b67f87d9735234275c782473b38244d2b3f07dc5fa43f5d95ba9e2528386e6d01e7e9db6709be

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,26 @@
 
 # Distant Client
 
+## Why?
+
+Active-Rest-Client is dead.
+
+FlexiRest doesn't work for me, and I'm too impatient to step painstakingly slow
+through Faraday code to figure out why.
+
+  * Distant uses HTTParty under the hood.
+  * If you need to set special headers, it's easy.
+  * If you need to disable ssl certificate authentication, it's easy.
+  * If you need to enable debugging information, it's easy.
+  * If you need to change the data coming to or from your API, it's easy.
+
+## What Not To Do:
+
+**DON'T**
+
+  * Think you can expose database functionality as a REST API. You will be disappointed by performance every time.
+  * Use this when another client for the API you want to consume already exists.
+
 ## Installation
 
 ### In your Gemfile
@@ -20,18 +40,32 @@ Distant.configure do |config|
 end
 
 class Organization < Distant::Base
+  attr_accessor :id, :name
   get :all, '/organizations'
   get :find, '/organizations/:id'
   has_many :networks, '/organizations/:id/networks'
+  translate do
+    from_hash do |hash|
+      recursive_underscore(hash)
+    end
+    to_hash do |obj|
+      {
+        id: obj.id,
+        fooId: obj.foo_id,
+      }
+    end
+  end
 end
 
 class Network < Distant::Base
+  attr_accessor :id, :organization_id, :name
   belongs_to :organization
   get :find, '/networks/:id'
   has_many :clients, '/networks/:id/clients'
 end
 
 class Client < Distant::Base
+  attr_accessor :id, :network_id, :name
   belongs_to :network
   get :find, '/clients/:id'
 end

data/distant.gemspec

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

data/lib/distant/base.rb

@@ -85,26 +85,21 @@ module Distant
         case response.code
         when 200..299
           parsed = JSON.parse(response.body, symbolize_names: true)
-          recursive_underscore(parsed)
+          parsed.is_a?(Array) ?
+            parsed.map{ |item| translator.translate_from_hash(item) }
+            : translator.translate_from_hash(item)
         else
           raise Distant::ApiError.new response
         end
       end
 
-      private
+      def translator
+        @translator
+      end
 
-      def recursive_underscore(thing)
-        if thing.is_a? Hash
-          out = {}
-          thing.each do |key, val|
-            out[key.to_s.underscore.to_sym] = recursive_underscore(val)
-          end
-          out
-        elsif thing.is_a? Array
-          thing.map{ |item| recursive_underscore(item) }
-        else
-          thing
-        end
+      def translate(&block)
+        @translator = Distant::Translator.new
+        translator.instance_eval(&block)
       end
     end
 

data/lib/distant/translator.rb

@@ -0,0 +1,42 @@
+
+module Distant
+  class Translator
+    attr_accessor :from_hash_translator, :to_hash_translator
+
+    def initialize
+      # Sensible defaults:
+      self.from_hash_translator = Proc.new{ |hash| hash }
+      self.to_hash_translator = Proc.new{ |obj| obj.to_h }
+    end
+
+    def translate_from_hash(hash)
+      self.from_hash_translator.call(hash)
+    end
+
+    def translate_to_hash(obj)
+      self.to_hash_translator.call(obj)
+    end
+
+    def from_hash(&block)
+      self.from_hash_translator = block
+    end
+
+    def to_hash(&block)
+      self.to_hash_translator = block
+    end
+
+    def recursive_underscore(thing)
+      if thing.is_a? Hash
+        out = {}
+        thing.each do |key, val|
+          out[key.to_s.underscore.to_sym] = recursive_underscore(val)
+        end
+        out
+      elsif thing.is_a? Array
+        thing.map{ |item| recursive_underscore(item) }
+      else
+        thing
+      end
+    end
+  end
+end

data/lib/distant.rb

@@ -5,6 +5,7 @@ require 'httparty'
 require 'logger'
 require 'ostruct'
 require 'distant/config'
+require 'distant/translator'
 require 'distant/base'
 require 'distant/connection'
 

data/spec/client/base_spec.rb

@@ -7,9 +7,22 @@ describe Distant::Base do
     end
     class Distant::BaseTest < Distant::Base
       attr_accessor :id, :name
-
       has_many :sub_tests, '/base/tests/:id/sub_tests'
+
+      translate do
+        from_hash do |hash|
+          recursive_underscore(hash)
+        end
+        to_hash do |obj|
+          {
+            id: obj.id,
+            fooId: obj.foo_id,
+          }
+        end
+      end
+
     end
+
     class Distant::SubTest < Distant::Base
       attr_accessor :id, :base_test_id
       belongs_to :base_test, ''

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: distant
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - John Drago
@@ -154,6 +154,7 @@ files:
 - lib/distant/base.rb
 - lib/distant/config.rb
 - lib/distant/connection.rb
+- lib/distant/translator.rb
 - spec/client/base_spec.rb
 - spec/client/config_spec.rb
 - spec/client/connection_spec.rb