trogdir_api_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c84869f5c27f1d6ff0e6b6c542f0066bf0c41fd5
-  data.tar.gz: 5140f152412bf8030873d74c07b54408b318f18c
+  metadata.gz: ea9c3e595f525942487a98181287f1c6ed41c6ad
+  data.tar.gz: f6e92275bd78dcaa4a273419af082f4d7a0feb77
 SHA512:
-  metadata.gz: b3f7af1b5cb00fb77e0e9cf1f4a4a2b9efc8ee254248423357f17956c1c8d5a71da35fd39560fcbab9c76a0120499d6a538aacf27c1f22f3aa01b7dbf678a7a1
-  data.tar.gz: 6878a454c3674445e8fd68326bb78a8f1c70400312e6276fd376e0990472a6b267c960a5f9b98311e56eb94c4b2c839cc347f1df6971beacf0736da9fa23a756
+  metadata.gz: c3aece16e1db4297f4e434c2494995e3d9202e17a5ec619b64ab3704705bf092a2c3151929ba9c28d639dc30f224832a4ec17497f7c6087d3afaa8d0ac44f914
+  data.tar.gz: 61e17953d264e2f47149750274ef0dfec6ae15438977805805f124b1c6c4c54000567ab8634616ace80238ae2261c2be4f28107d0eeada4b3b22574d72b400d5

data/README.md

@@ -6,10 +6,89 @@ Installing
 
 Add `gem 'trogdir_api_client'` to your `Gemfile` and run `bundle`
 
+Configuration
+-------------
+
+```ruby
+TrogdirAPIClient.configure do |config|
+  # Optional:
+  # config.scheme = 'http'
+  # config.host = 'localhost'
+  # config.script_name = nil
+  # config.version = 'v1'
+  
+  # Required:
+  config.access_id = '**************'
+  config.secret_key = '*****************************************'
+end
+```
+
 Usage
 -----
 
-TODO
+### Example Syncinator
+
+```ruby
+require 'trogdir_api_client'
+require 'multi_json'
+
+trogdir = Trogdir::APIClient::ChangeSyncs.new
+hashes = trogdir.start.perform.parse
+
+hashes.each do |hash|
+  sync_log_id = hash['sync_log_id']
+  action = hash['action']
+  person_id = hash['person_id']
+  scope = hash['scope']
+  original = hash['original']
+  modified = hash['modified']
+
+  action_taken = 'nothing'
+
+  begin
+    person = Person.find(person_id)
+
+    case scope
+    when 'person'
+      case action
+      when 'create'
+        # do stuff
+        action_taken = 'create'
+      when 'update'
+        # do stuff
+        action_taken = 'update'
+      when 'destroy'
+        # do stuff
+        action_taken = 'destroy'
+      end
+    when 'id'
+      case action
+      when 'create'
+        # do stuff
+        action_taken = 'create'
+      when 'update'
+        # do stuff
+        action_taken = 'update'
+      when 'destroy'
+        # do stuff
+        action_taken = 'destroy'
+      end
+    when 'email'
+      # blah
+    when 'photo'
+      # blah
+    when 'phone'
+      # blah
+    when 'address'
+      # blah
+    end
+
+    trogdir.finish(sync_log_id: sync_log_id, action: action_taken).perform
+  rescue StandardError => err
+    trogdir.error(sync_log_id: sync_log_id, message: err.message).perform
+  end
+end
+```
 
 License
 -------

data/lib/trogdir/api_client/addresses.rb

@@ -1,8 +1,7 @@
 module Trogdir
   module APIClient
     class Addresses < Weary::Client
-      domain TrogdirAPIClient.config.base_url
-      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+      include Settings
 
       get :index, '/people/{uuid}/addresses'
 
@@ -20,4 +19,4 @@ module Trogdir
       delete :destroy, '/people/{uuid}/addresses/{address_id}'
     end
   end
-end
+end

data/lib/trogdir/api_client/change_syncs.rb

@@ -1,8 +1,7 @@
 module Trogdir
   module APIClient
     class ChangeSyncs < Weary::Client
-      domain TrogdirAPIClient.config.base_url
-      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+      include Settings
 
       put :start, '/change_syncs/start'
 
@@ -16,4 +15,4 @@ module Trogdir
       end
     end
   end
-end
+end

data/lib/trogdir/api_client/emails.rb

@@ -1,8 +1,7 @@
 module Trogdir
   module APIClient
     class Emails < Weary::Client
-      domain TrogdirAPIClient.config.base_url
-      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+      include Settings
 
       get :index, '/people/{uuid}/emails'
 
@@ -20,4 +19,4 @@ module Trogdir
       delete :destroy, '/people/{uuid}/emails/{email_id}'
     end
   end
-end
+end

data/lib/trogdir/api_client/ids.rb

@@ -1,9 +1,7 @@
 module Trogdir
   module APIClient
     class IDs < Weary::Client
-      domain TrogdirAPIClient.config.base_url
-      # use Weary::Middleware::ContentType
-      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+      include Settings
 
       get :index, '/people/{uuid}/ids'
 
@@ -20,4 +18,4 @@ module Trogdir
       delete :destroy, '/people/{uuid}/ids/{id_id}'
     end
   end
-end
+end

data/lib/trogdir/api_client/people.rb

@@ -1,9 +1,7 @@
 module Trogdir
   module APIClient
     class People < Weary::Client
-      domain TrogdirAPIClient.config.base_url
-      # use Weary::Middleware::ContentType
-      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+      include Settings
 
       get :index, '/people' do |resource|
         resource.optional :affiliation
@@ -49,4 +47,4 @@ module Trogdir
       end
     end
   end
-end
+end

data/lib/trogdir/api_client/phones.rb

@@ -1,8 +1,7 @@
 module Trogdir
   module APIClient
     class Phones < Weary::Client
-      domain TrogdirAPIClient.config.base_url
-      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+      include Settings
 
       get :index, '/people/{uuid}/phones'
 
@@ -20,4 +19,4 @@ module Trogdir
       delete :destroy, '/people/{uuid}/phones/{phone_id}'
     end
   end
-end
+end

data/lib/trogdir/api_client/photos.rb

@@ -1,8 +1,7 @@
 module Trogdir
   module APIClient
     class Photos < Weary::Client
-      domain TrogdirAPIClient.config.base_url
-      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+      include Settings
 
       get :index, '/people/{uuid}/photos'
 
@@ -19,4 +18,4 @@ module Trogdir
       delete :destroy, '/people/{uuid}/photos/{photo_id}'
     end
   end
-end
+end

data/lib/trogdir/api_client/settings.rb

@@ -0,0 +1,11 @@
+module Trogdir
+  module APIClient
+    module Settings
+      def self.included(base)
+        base.send :domain, TrogdirAPIClient.config.base_url
+        base.send :adapter, Weary::Adapter::NetHttpAdvanced
+        base.send :use, Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+      end
+    end
+  end
+end

data/lib/trogdir_api_client.rb

@@ -14,6 +14,7 @@ end
 
 module Trogdir
   module APIClient
+    autoload :Settings, 'trogdir/api_client/settings'
     autoload :People, 'trogdir/api_client/people'
     autoload :IDs, 'trogdir/api_client/ids'
     autoload :Emails, 'trogdir/api_client/emails'
@@ -28,4 +29,8 @@ module Weary
   module Middleware
     autoload :HMACAuth, 'weary/middleware/hmac_auth'
   end
-end
+
+  module Adapter
+    autoload :NetHttpAdvanced, 'weary/adapters/net_http_advanced'
+  end
+end

data/lib/trogdir_api_client/version.rb

@@ -1,3 +1,3 @@
 module TrogdirAPIClient
-  VERSION = '0.1.0'
-end
+  VERSION = '0.2.0'
+end

data/lib/weary/adapters/net_http_advanced.rb

@@ -0,0 +1,16 @@
+module Weary
+  module Adapter
+    class NetHttpAdvanced < NetHttp
+      class << self
+        attr_accessor :timeout
+      end
+
+      def self.connect(request)
+        connection = socket(request)
+        connection.read_timeout = timeout unless timeout.nil?
+        response = connection.request prepare(request)
+        Rack::Response.new response.body || "", response.code, normalize_response(response.to_hash)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trogdir_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2014-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api-auth
@@ -151,9 +151,11 @@ files:
 - lib/trogdir/api_client/people.rb
 - lib/trogdir/api_client/phones.rb
 - lib/trogdir/api_client/photos.rb
+- lib/trogdir/api_client/settings.rb
 - lib/trogdir_api_client.rb
 - lib/trogdir_api_client/configuration.rb
 - lib/trogdir_api_client/version.rb
+- lib/weary/adapters/net_http_advanced.rb
 - lib/weary/middleware/hmac_auth.rb
 homepage: https://github.com/biola/trogdir-api-client
 licenses:
@@ -180,3 +182,4 @@ signing_key:
 specification_version: 4
 summary: Client for the Trogdir directory API
 test_files: []
+has_rdoc: