web-connect 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b49c3dd8435586f607c392c5fdbac9efa14ddd8
-  data.tar.gz: 5ab7835fcf6e5d3ec477dc7941be3a0043fe91fc
+  metadata.gz: e6587764f67f4e6ce9e10f6d86edb1bf89c916c4
+  data.tar.gz: 952c9040de0758ae2e546f932f04887d59e84b6a
 SHA512:
-  metadata.gz: 7b6afcb42860f58ac33493823d149bf9309d9c79a473018ce06da9841e90394dfa0b302db1ebb704e4d084a1f233601d5bd98849a51422e59e9f9118bd030583
-  data.tar.gz: 8e4a1b75e67982ff9c7ac9d8b443091531f0d31819a1e14002dbac38159d07d12f5863ffab2c3ce1349b40885251f4f5c969900881d5dc81b80f43f9741f7167
+  metadata.gz: cfe5853e869e8910bad896aa3eeddbdccb479bbf122160f717df5c63488abbb4d1c57e0c61d36287b9bd74db380a63a452c5668ad00bce23c12c8d47304c5981
+  data.tar.gz: e785afeea27467e52e926906b3ea2d1ee7819d9ca03d55ec25a875e95476dc7b045c0e8cd894ecd243e57e31ec9852fb5b97d6adbf4b0b0bdfdba50b85b1bcf7

data/README.md

@@ -1 +1,137 @@
-This gem provides connectivity between your app and Netfira products.
+This gem provides server-side functionality for the [Netfira WebConnect](http://netfirawebconnect.com/) protocol.
+
+## Installation
+
+    gem install web-connect
+    
+## Usage
+
+**If you're using Rails, use the [web-connect-rails](https://github.com/netfira/web-connect-rails) gem.**
+
+To take your WebConnect-enabled app online, use the bundled Rack app and request filter middleware.
+
+```ruby
+# config.ru
+require 'web-connect'
+require 'my-app'
+
+use Netfira::WebConnect::RequestFilter
+run Netfira::WebConnect::RackApp
+```
+
+> The `RequestFilter` middleware is not essential, but can provide speed and compatibility advantages for older clients.
+
+### Configuration
+
+This is a typical WebConnect configuration.
+
+```ruby
+Netfira::WebConnect.configure do |c|
+  # This database configuration will be used by ActiveRecord
+  c.db = {
+      adapter: 'sqlite3',
+      database: 'test.sqlite3'
+  }
+  
+  # This string will be prefixed to names of tables created by
+  # WebConnect
+  c.db_table_prefix = 'nf_'
+  
+  # Enabled or disable storage of fields not included in WebConnect's
+  # default schema
+  c.custom_fields = false
+  
+  # Default time zone
+  c.time_zone = 'Australia/Sydney'
+  
+  # WebConnect activity will be logged here
+  c.logger = Logger.new(STDERR)
+  
+  # Use any Paperclip storage configuration you like here. WebConnect
+  # provides the :shop_id and :model_type interpolations.
+  c.file_store = {
+      path: File.dirname(__FILE__) + '/uploads/shop_:shop_id/:model_type/:filename'
+  }
+  
+  # This block will be passed a shop name and password whenever a client
+  # needs to authenticate
+  c.on_authenticate do |shop_name, password|
+    shop = Shop.find_by(name: shop_name)
+    shop && shop.password == password
+  end
+  
+  # Session lifetime (omit to disable sessions)
+  c.session_lifetime = 5.days
+end
+```
+
+### Migrations
+
+WebConnect uses ActiveRecord migrations to manage its database. It comes with two rake tasks.
+
+    rake wc:migrate   # Migrate the database
+    rake wc:rollback  # Roll back a single migration
+    
+If your application uses ActiveRecord, these migrations will be managed independently of your application's migrations.
+
+Run these migrations when you first install WebConnect, and whenever you update the WebConnect gem.
+
+### Data
+
+You can access WebConnect data through the `Netfira::WebConnect::Models` namespace.
+
+```ruby
+product = Netfira::WebConnect::Models::Product.first
+
+product.unit_price   # BigDecimal
+product.name         # Netfira::WebConnect::Model::Record::TranslatedString
+product.name[:en_AU] # String
+```
+
+You can lookup records using their original client-side identifiers using `find_by_origin_id`.
+
+```ruby
+shop = Netfira::WebConnect::Models::Shop.first
+
+product = Netfira::WebConnect::Models::Product.find_by_origin_id(shop, 'product123')
+# Or
+product = shop.products.find_by(product_id: 'product123')
+```
+
+### Events
+
+Events in WebConnect are handled by delegates. Define your delegates like so:
+
+```ruby
+class MyDelegate
+  def on_create_product(product)
+    # ...
+  end
+end
+```
+
+Then add delegates to WebConnect:
+
+```ruby
+Netfira::WebConnect.event_delegates << MyDelegate.new
+```
+
+The `event_delegates` collection is an array. You can push, merge, delete etc as you would a normal array.
+
+Any object can be an event delegate, and you can add as many as you like. They only need to respond any of the method signatures below.
+
+#### Delegate Method Signatures
+
+For               |Example                             |Arguments                  |Remarks
+------------------|------------------------------------|---------------------------|-------
+New Records       |`on_create_buyer`                   |`buyer`                    | Dispatched after record is created
+Record Updates    |`on_update_image`                   |`image`, `previous_values` | Second argument is a hash of changed columns as they were before they were changed
+Deleted Records   |`on_delete_category`                |`category`                 | Dispatched before records are deleted
+New Relations     |`on_add_image_to_product`           |`image`, `product`         | `on_add_product_to_image` also works, causing the arguments to also be swapped
+Deleted Relations |`on_remove_product_from_category`   |`product`, `category`      | Same as above
+Change Setting    |`on_change_setting`                 |`setting`, `old`           | `setting` will have `shop`, `key`, and `value` methods. `old` is the previous value.
+
+Except for `previous_values`, all arguments above are instances of `Netfira::WebConnect::Model::Record`.
+
+Events are dispatched to delegates synchronously, on request threads. Create new threads if you want to prevent your handlers from blocking HTTP responses to WebConnect clients.
+

data/lib/netfira/web_connect/rack_app.rb

@@ -6,7 +6,7 @@ module Netfira::WebConnect
       begin
         body, headers = handle_request(env)
         if headers['Content-Type']
-          [200, headers, body]
+          [200, headers, [body]]
         else
           make_response 200, body, headers
         end
@@ -38,10 +38,10 @@ module Netfira::WebConnect
       [
           status,
           {
-              :'Content-Type' => 'application/json',
-              :'Content-Length' => body_string.length
+              'Content-Type' => 'application/json',
+              'Content-Length' => body_string.length.to_s
           }.merge(headers),
-          body_string
+          [body_string]
       ]
     end
 

data/lib/netfira/web_connect/rack_app/actions/{version_8 → version_1}/info.rb

@@ -1,5 +1,5 @@
 class Netfira::WebConnect::RackApp
-  module Action::Version8
+  module Action::Version1
     class Info < Action
       def call
         {

data/lib/netfira/web_connect/rack_app/actions/version_1/not_supported.rb

@@ -1,6 +1,6 @@
 class Netfira::WebConnect::RackApp
   module Action::Version1
-    %w[Commit Info Settings Checksums Files].each do |name|
+    %w[Commit Settings Checksums Files].each do |name|
       const_set name, (Class.new(Action) do
         def call
           raise Exceptions::HttpExceptions::NotFound

data/lib/netfira/web_connect/version.rb

@@ -1,5 +1,5 @@
 module Netfira
   module WebConnect
-    VERSION = '0.1.6'
+    VERSION = '0.1.7'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web-connect
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Neil E. Pearson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -205,13 +205,13 @@ files:
 - lib/netfira/web_connect/rack_app/action_helpers/data_types.rb
 - lib/netfira/web_connect/rack_app/action_helpers/env_importer.rb
 - lib/netfira/web_connect/rack_app/action_helpers/env_methods.rb
+- lib/netfira/web_connect/rack_app/actions/version_1/info.rb
 - lib/netfira/web_connect/rack_app/actions/version_1/not_supported.rb
 - lib/netfira/web_connect/rack_app/actions/version_8/checksums.rb
 - lib/netfira/web_connect/rack_app/actions/version_8/commit.rb
 - lib/netfira/web_connect/rack_app/actions/version_8/commit/records.rb
 - lib/netfira/web_connect/rack_app/actions/version_8/commit/relations.rb
 - lib/netfira/web_connect/rack_app/actions/version_8/files.rb
-- lib/netfira/web_connect/rack_app/actions/version_8/info.rb
 - lib/netfira/web_connect/rack_app/actions/version_8/settings.rb
 - lib/netfira/web_connect/rack_app/exceptions.rb
 - lib/netfira/web_connect/rack_app/exceptions/http_exception.rb