web-connect 0.4.11 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57e9bb59d41e8a0c01c87c705f8025d1d232f4ac
-  data.tar.gz: 519a6611cddde1f5c82be9e983d4236eaaa028a3
+  metadata.gz: 273dc9f8b0c167f981f7dc726a5a2c90b4b3cca9
+  data.tar.gz: cf3251442213fa65617e0b69591345596efbf294
 SHA512:
-  metadata.gz: 44e149eb63bb57f314fdd9b5a530aa969d2910aa506c6f719aef1c6f3e40d8c95214127a0d3f795a60025cdb5c41f3a3f2dcfa62bb914f86a4fa37993bf7ffe5
-  data.tar.gz: 62ec603899fc3a43d0c83424c0ff94b7b0c5c3420c92ac18fc2f681ccb63a6facd4230cf9a665cdd3e13b017f771f2e6b50f61b1154b336a04be0f614ddaae56
+  metadata.gz: b7c425a18993a3ef9138327ced689d54f82ca5acb214e119b24c9bf41ca7ef7682070bbf2a70c4f43627b3c77978d28d56b430995c9aa8cbcc845ff7fc4352a1
+  data.tar.gz: a94076bac46ff5f1a6ef825a47d3895b7b54910155284b120556a50c6dbddd0b6ee54ec4b3fb0c2ddb3638dcc05d39682b0efa5c644f2d5e291060c18e96a158

data/lib/netfira/web_connect/components/octa_word.rb

@@ -5,7 +5,7 @@ class Netfira::WebConnect::OctaWord
   class << self
 
     def from_binary(digest)
-      new digest
+      new digest if digest
     end
 
     alias_method :from, :from_binary

data/lib/netfira/web_connect/migration.rb

@@ -23,14 +23,9 @@ module Netfira::WebConnect
         t.string options[:origin_key] || :"#{table_name.to_s.singularize}_id", index: true unless options[:writable]
         yield t
         t.references :shop, index: true
-        if options[:tree]
-          t.string :parent_id
-          t.index [:shop_id, :parent_id]
-        end
-        if options[:sendable]
-          t.binary :guid, index: true
-          t.integer :delivery_status, default: 0, limit: 3, index: true
-        end
+        create_tree_table t if options[:tree]
+        create_writable_table t if options[:writable]
+        create_sendable_table t if options[:sendable]
         t.binary :digest, limit: 16
         t.timestamps
         t.datetime :deleted_at
@@ -55,20 +50,13 @@ module Netfira::WebConnect
     end
 
     def create_file_table(table_name)
-      create_table table_name do |t|
-        t.references :shop, index: true
-        t.string :file_name, index: true
+      create_record_table table_name, origin_key: :file_name, file: true do |t|
         t.string :remote_location
         t.string :locale
         yield t if block_given?
         t.integer :size
         t.binary :checksum, limit: 16
-        t.binary :digest, limit: 16
-        t.timestamps
-        t.datetime :deleted_at
-        t.index :deleted_at
       end
-      add_table_def table_name, {}, true
     end
 
     def create_relation_table(first, second)
@@ -81,9 +69,8 @@ module Netfira::WebConnect
       end
     end
 
-    def add_table_def(table_name, options, is_file = false)
-      Models::Table.create options.select{|k| %i[origin_key writable sendable].include? k}.merge name: table_name,
-                                                                                                 file: is_file
+    def add_table_def(table_name, options)
+      Models::Table.create options.select{|k| %i[origin_key writable sendable file].include? k}.merge name: table_name
     end
 
     def write(text = '')
@@ -107,6 +94,20 @@ module Netfira::WebConnect
       Netfira::WebConnect.db_table_prefix name
     end
 
+    def create_tree_table(t)
+      t.string :parent_id
+      t.index [:shop_id, :parent_id]
+    end
+
+    def create_writable_table(t)
+      t.binary :guid, limit: 16
+      t.index :guid, unique: true
+    end
+
+    def create_sendable_table(t)
+      t.integer :delivery_status, default: 0, limit: 3, index: true
+    end
+
   end
 end
 

data/lib/netfira/web_connect/model/record/materialization.rb

@@ -45,6 +45,9 @@ module Netfira::WebConnect
         # Set up tree behaviour (parent/child relations)
         klass.include Model::Record::Tree if klass.tree?
 
+        # Set up writable behaviour
+        klass.include Model::Record::Writable if klass.writable?
+
         # Set up sendable behaviour
         klass.include Model::Record::Sendable if klass.sendable?
 

data/lib/netfira/web_connect/model/record/sendable.rb

@@ -4,25 +4,28 @@ module Netfira::WebConnect
     module Sendable
       extend ActiveSupport::Concern
 
+      DELIVERY_STATUSES = %i(unsent sent delivered)
+
       included do
-        after_initialize :create_guid
-        enum delivery_status: [:unsent, :sent, :delivered]
-      end
 
-      def guid
-        @guid ||= Guid.from(self[:guid])
+        # Make #delivery_status an enumeration, generating methods like #sent?, #sent!, etc.
+        enum delivery_status: DELIVERY_STATUSES
+
+        # Scopes
+        sent_and_undelivered_index = DELIVERY_STATUSES.index(:sent)
+        scope :sent_and_undelivered, -> { where delivery_status: sent_and_undelivered_index }
+
       end
 
-      def guid=(value)
-        raise 'GUIDs are read-only'
+      def send!
+        sent!
+        save!
+        #TODO: send notification to client(s)
+        self
       end
 
       private
 
-      def create_guid
-        self[:guid] ||= (@guid = Guid.create).b
-      end
-
     end
 
   end

data/lib/netfira/web_connect/model/record/translation.rb

@@ -48,11 +48,11 @@ module Netfira::WebConnect
       end
 
       def single_name
-        @single_name ||= Netfira::WebConnect.db_table_l10n_suffix @owner_class.single_name
+        @single_name ||= Netfira::WebConnect.db_table_l10n_suffix(@owner_class.single_name).freeze
       end
 
       def plural_name
-        @plural_name ||= Netfira::WebConnect.db_table_l10n_suffix @owner_class.plural_name
+        @plural_name ||= Netfira::WebConnect.db_table_l10n_suffix(@owner_class.plural_name).freeze
       end
 
     end

data/lib/netfira/web_connect/model/record/writable.rb

@@ -0,0 +1,85 @@
+module Netfira::WebConnect
+  # noinspection RubyStringKeysInHashInspection
+  class Model::Record
+
+    module Writable
+      extend ActiveSupport::Concern
+
+      included do
+
+        # Add a model initializer that generates a random GUID
+        after_initialize :create_guid
+
+        # Attributes that can be sent
+        def self.attributes_to_send
+          @attributes_to_send ||= attribute_names +
+              (has_languages? ? self::Translation.translated_attribute_names : []) -
+              Serializer::EXCLUDE_FROM_SERIALIZE
+        end
+
+      end
+
+      def to_deliverable
+        attributes_as_camel_cased_hash.tap do |result|
+
+          # Include GUIDs for sendables, e.g. "orderId" => "hd8jdi38jds02893hdo8wq3"
+          result["#{self.class.single_name_camel}Id"] = guid.to_s if sendable?
+
+          # Included timestamps, e.g. "createdAt" => "2014-09-27T11:10:00+10:00"
+          %w(created_at updated_at).each do |field|
+            result[field.camelize :lower] = __send__(field).strftime '%FT%T%:z'
+          end
+
+          # Include collections, e.g. "lines" => [{...}, ...]
+          result.merge! self.class.schema.has_many.keys.map { |k| [k, __send__(k).map(&:to_deliverable)] }.to_h
+        end
+      end
+
+      # Used by older downstream methods, e.g. newOrders, newInboundDocuments etc
+      def to_deprecated_downstream
+        fields = attributes_as_camel_cased_hash
+        if sendable?
+          sendable_fields = {
+              "#{self.class.single_name_camel}GUID" => guid.to_s,
+              "#{self.class.single_name_camel}Id" => id.to_s,
+              finalised: '1'
+          }
+          fields.merge! sendable_fields
+        end
+        {created: created_at.to_i, fields: fields}.merge deprecated_downstream_children
+      end
+
+      def guid
+        @guid ||= Guid.from(self[:guid])
+      end
+
+      def guid=(value)
+        raise 'GUIDs are read-only'
+      end
+
+      private
+
+      def attributes_as_camel_cased_hash
+        self.class.attributes_to_send.map { |key| [key.camelize(:lower), __send__(key).to_s] }.to_h
+      end
+
+      def deprecated_downstream_children
+        self.class.schema.has_many.keys.map do |key|
+          [key, __send__(key).map(&:to_deprecated_downstream)]
+        end.to_h
+      end
+
+      def create_guid
+        self[:guid] ||= (@guid = Guid.create).b
+      end
+
+      module ClassMethods
+        def single_name_camel
+          @single_name_camel ||= single_name.camelize :lower
+        end
+      end
+
+    end
+
+  end
+end

data/lib/netfira/web_connect/model/record.rb

@@ -3,6 +3,7 @@ require_relative 'record/materialization'
 require_relative 'record/serializer'
 require_relative 'record/digests'
 require_relative 'record/sendable'
+require_relative 'record/writable'
 require_relative 'record/events'
 
 module Netfira::WebConnect
@@ -15,6 +16,15 @@ module Netfira::WebConnect
 
     class << self
 
+      def sendable
+        return super unless self == Model::Record # This should raise an error!
+        @sendable_classes ||= Models.constants.map do |name|
+          Models.const_get name
+        end.select do |klass|
+          Class === klass && klass < Model::Record && klass.sendable?
+        end
+      end
+
       def table_name
         @table_name ||= if self == Model::Record
           Models::Table.table_name
@@ -32,13 +42,7 @@ module Netfira::WebConnect
       end
 
       def origin_key
-        @origin_key ||= if sendable?
-                          :guid
-                        elsif writable?
-                          nil
-                        else
-                          (table_props.origin_key || "#{single_name}_id").to_sym
-                        end
+        @origin_key ||= writable? ? :guid : (table_props.origin_key || "#{single_name}_id").to_sym
       end
 
       def writable?
@@ -55,6 +59,7 @@ module Netfira::WebConnect
       end
 
       def find_or_initialize_by_origin_id(shop, id)
+        id = Guid.from_base64(id).b if origin_key == :guid
         find_by_origin_id(shop, id).tap { |record| record.restore! if record && record.destroyed? } or
             new(origin_key => id, shop_id: shop.id)
       end

data/lib/netfira/web_connect/model.rb

@@ -17,11 +17,11 @@ module Netfira::WebConnect
       end
 
       def single_name
-        @single_name ||= name.demodulize.underscore
+        @single_name ||= name.demodulize.underscore.freeze
       end
 
       def plural_name
-        @plural_name ||= single_name.pluralize
+        @plural_name ||= single_name.pluralize.freeze
       end
     end
 

data/lib/netfira/web_connect/rack_app/action_helpers/env_importer.rb

@@ -91,7 +91,7 @@ module Netfira::WebConnect
 
         # Unserialize JSON
         begin
-          @input = JSON.parse @input.read, quirks_mode: true if request.media_type == 'application/json'
+          @input = JSON.parse @input.read.sub(/\A\z/, 'null'), quirks_mode: true if request.media_type == 'application/json'
         rescue JSON::ParserError => error
           raise BadRequest.new('Invalid JSON in request body', details: error.message.sub(/^\d+:\s*/, ''))
         end

data/lib/netfira/web_connect/rack_app/actions/version_8/confirm.rb

@@ -0,0 +1,32 @@
+module Netfira::WebConnect
+  class RackApp
+    module Action::Version8
+      class Confirm < Action
+
+        def call
+          allow :put, Hash
+          self.class.types.each do |type, klass|
+            ids = input[type]
+            ids.each { |guid| confirm_delivery klass, guid if %r`^[\w+/]{22}$` === guid } if Array === ids
+          end
+          {}
+        end
+
+        private
+
+        def confirm_delivery(klass, guid)
+          record = klass.find_by(shop_id: shop.id, guid: Guid.from_base64(guid).b)
+          if record
+            record.delivered!
+            record.save!
+          end
+        end
+
+        def self.types
+          @types ||= Model::Record.sendable.map { |k| [k.plural_name.camelize(:lower), k] }.to_h
+        end
+
+      end
+    end
+  end
+end

data/lib/netfira/web_connect/rack_app/actions/version_8/deprecated_downstream.rb

@@ -0,0 +1,55 @@
+class Netfira::WebConnect::RackApp
+  module Action::Version8
+
+    class_methods = Module.new do
+
+      def record_class
+        @record_class ||= Netfira::WebConnect::Models.const_get self::MODEL_NAME
+      end
+
+      def collection_name
+        @collection_name ||= self::MODEL_NAME.pluralize.downcase.freeze
+      end
+
+    end
+
+    fetch_class = Class.new Action do
+      extend class_methods
+
+      def call
+        allow :get
+        {self.class.collection_name => undelivered.map(&:to_deprecated_downstream)}
+      end
+
+      private
+
+      def undelivered
+        self.class.record_class.sent_and_undelivered.where(shop_id: shop.id)
+      end
+
+    end
+
+    confirm_class = Class.new Action do
+      extend class_methods
+
+      def call
+        allow :put
+        record = self.class.record_class.sent_and_undelivered.find_by(shop_id: shop.id, id: query_string['id'])
+        if record
+          record.delivered!
+          record.save
+        end
+        {}
+      end
+
+    end
+
+    # There will be more classes later, e.g. Documents. When they are needed, they can
+    # be added to the array below.
+    %w(Order).each do |name|
+      const_set :"New#{name.pluralize}", Class.new(fetch_class  ).tap { |c| c::MODEL_NAME = name.freeze }
+      const_set :"Confirm#{name}",       Class.new(confirm_class).tap { |c| c::MODEL_NAME = name.freeze }
+    end
+
+  end
+end

data/lib/netfira/web_connect/rack_app/actions/version_8/fetch.rb

@@ -0,0 +1,24 @@
+module Netfira::WebConnect
+  class RackApp
+    module Action::Version8
+      class Fetch < Action
+
+        def call
+          allow :get
+          self.class.types.map { |type, klass| [type, records_for_class(klass)] }.select { |(_, x)| x && x.first }.to_h
+        end
+
+        private
+
+        def records_for_class(klass)
+          klass.sent_and_undelivered.where(shop_id: shop.id).map &:to_deliverable
+        end
+
+        def self.types
+          @types ||= Model::Record.sendable.map { |k| [k.plural_name.camelize(:lower), k] }.to_h
+        end
+
+      end
+    end
+  end
+end

data/lib/netfira/web_connect/rack_app/exceptions/user_exception.rb

@@ -0,0 +1,11 @@
+module Netfira::WebConnect::RackApp::Exceptions
+  class UserException < Base
+
+    attr_reader :original_exception
+
+    def initialize(original_exception)
+      @original_exception = original_exception
+    end
+
+  end
+end

data/lib/netfira/web_connect/rack_app/exceptions.rb

@@ -1,7 +1,8 @@
 module Netfira::WebConnect::RackApp::Exceptions
-  class Base < Exception
+  class Base < RuntimeError
   end
 end
 
 require_relative 'exceptions/http_exception'
 require_relative 'exceptions/send_file'
+require_relative 'exceptions/user_exception'

data/lib/netfira/web_connect/rack_app.rb

@@ -26,7 +26,11 @@ module Netfira::WebConnect
       rescue => e
         # TODO: provide a way to silence these (i.e. for prod environments)
         # TODO: log errors
-        raise e if defined? DONT_CATCH_ALL_EXCEPTIONS
+        if Exceptions::UserException === e
+          e = e.original_exception
+        else
+          raise e if defined? DONT_CATCH_ALL_EXCEPTIONS
+        end
         body = {
             errorCode: 1,
             errorMessage: 'Uncaught Exception',

data/lib/netfira/web_connect/schema/table.rb

@@ -28,7 +28,15 @@ module Netfira::WebConnect
       @relations = klass.related_classes
     end
 
-    IGNORE_COLUMNS = %w[id shop_id created_at updated_at digest]
+    def has_many
+      @has_many ||= klass.reflect_on_all_associations(:has_many).select do |a|
+        a.klass < Model::Record && !a.options[:through]
+      end.map do |association|
+        [association.name, association.klass]
+      end.to_h
+    end
+
+    IGNORE_COLUMNS = %w[id shop_id created_at updated_at deleted_at digest]
 
     def columns
       @columns ||= klass.columns_hash.reject{ |k| IGNORE_COLUMNS.include? k }.merge(l10n_columns).map{ |k, v| [k.to_sym, v.type.to_s] }.to_h
@@ -40,7 +48,8 @@ module Netfira::WebConnect
           relations:  relations.map{ |klass| klass.name.demodulize.pluralize },
           singular:   singular,
           primaryKey: [primary_key.to_s.camelize(:lower)],
-          localize:   l10n_columns.keys.map{ |k| k.camelize :lower }
+          localize:   l10n_columns.keys.map{ |k| k.camelize :lower },
+          hasMany:   has_many.map{ |type, klass| [type, klass.plural_name.camelize] }.to_h
       }
     end
 

data/lib/netfira/web_connect/version.rb

@@ -1,6 +1,6 @@
 module Netfira
   module WebConnect
-    VERSION = '0.4.11'
+    VERSION = '0.4.12'
     PLATFORM_AND_VERSION = 'Rack/' << VERSION
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web-connect
 version: !ruby/object:Gem::Version
-  version: 0.4.11
+  version: 0.4.12
 platform: ruby
 authors:
 - Neil E. Pearson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-21 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -146,6 +146,7 @@ files:
 - lib/netfira/web_connect/model/record/translation.rb
 - lib/netfira/web_connect/model/record/translations.rb
 - lib/netfira/web_connect/model/record/tree.rb
+- lib/netfira/web_connect/model/record/writable.rb
 - lib/netfira/web_connect/model/relation.rb
 - lib/netfira/web_connect/model/relation/events.rb
 - lib/netfira/web_connect/model/support.rb
@@ -172,6 +173,9 @@ files:
 - 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/confirm.rb
+- lib/netfira/web_connect/rack_app/actions/version_8/deprecated_downstream.rb
+- lib/netfira/web_connect/rack_app/actions/version_8/fetch.rb
 - lib/netfira/web_connect/rack_app/actions/version_8/files.rb
 - lib/netfira/web_connect/rack_app/actions/version_8/records.rb
 - lib/netfira/web_connect/rack_app/actions/version_8/settings.rb
@@ -179,6 +183,7 @@ files:
 - lib/netfira/web_connect/rack_app/exceptions.rb
 - lib/netfira/web_connect/rack_app/exceptions/http_exception.rb
 - lib/netfira/web_connect/rack_app/exceptions/send_file.rb
+- lib/netfira/web_connect/rack_app/exceptions/user_exception.rb
 - lib/netfira/web_connect/request_filter.rb
 - lib/netfira/web_connect/schema.rb
 - lib/netfira/web_connect/schema/table.rb