web-connect 0.1.0

data/lib/netfira/web_connect/rack_app.rb

@@ -0,0 +1,56 @@
+require 'ostruct'
+
+module Netfira::WebConnect
+  class RackApp
+    def call(env)
+      begin
+        body, headers = handle_request(env)
+        if headers['Content-Type']
+          [200, headers, body]
+        else
+          make_response 200, body, headers
+        end
+      rescue Exceptions::HttpException => e
+        make_response e.code, {errorMessage: e.message}, e.headers, e.code
+      end
+    end
+
+    def latest_api_version
+      Action.latest_version
+    end
+
+    private
+
+    def handle_request(env)
+      # Match [/]<api-version-number>/<anything other than a forward slash>
+      raise NotFound unless env['PATH_INFO'] =~ /\A\/?(\d+)\/([^\/]+)/
+      version = $1.to_i
+      action_name = $2.to_sym
+      action = Action.create(action_name, version)
+      raise NotFound unless action
+      action.import_env env
+      body = action.call
+      [body, action.headers]
+    end
+
+    def make_response(status, body = {}, headers = {}, error_code = 0)
+      body_string = {errorCode: error_code}.merge(body).to_json
+      [
+          status,
+          {
+              :'Content-Type' => 'application/json',
+              :'Content-Length' => body_string.length
+          }.merge(headers),
+          body_string
+      ]
+    end
+
+  end
+end
+
+require_relative 'rack_app/exceptions'
+require_relative 'rack_app/action'
+
+class Netfira::WebConnect::RackApp
+  include Exceptions::HttpExceptions
+end

data/lib/netfira/web_connect/request_filter.rb

@@ -0,0 +1,66 @@
+require 'zlib'
+require 'stringio'
+
+module Netfira::WebConnect
+  class RequestFilter
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if (env['CONTENT_TYPE'] || env['HTTP_CONTENT_TYPE']) == 'application/x-netfira-webconnect-packed'
+        begin
+          unpack env
+        rescue Zlib::GzipFile::Error => e
+          return [400, {}, {errorCode: 19, errorMessage: "Gzip decompression error: #{e.message}"}]
+        end
+      end
+      env['WC_ACCEPTABLE_REQUEST_TYPES'] = %w[packed unpacked]
+      @app.call env
+    end
+
+    def unpack(env)
+      env['original.rack.input'] = input = env['rack.input']
+
+      input = Zlib::GzipReader.new(input) if (env['CONTENT_ENCODING'] || env['HTTP_CONTENT_ENCODING']) == 'gzip'
+
+      method, path, query_string, headers, body = parse_request(input)
+
+      %w[REQUEST_METHOD PATH_INFO QUERY_STRING].each{ |field| env["OUTER_#{field}"] = env[field] }
+
+      env['REQUEST_METHOD'] = method
+      env['PATH_INFO'] = path
+      env['QUERY_STRING'] = query_string || ''
+
+      headers.each do |key, value|
+        field = key =~ /^CONTENT_/ ? '' : 'HTTP_'
+        field << key.upcase.gsub('-', '_')
+        env["OUTER_#{field}"] = env[field] if env[field]
+        env[field] = value
+      end
+
+      env['rack.input'] = StringIO.new(body || '')
+    end
+
+    private
+
+    def parse_request(input)
+      input.rewind
+
+      body = ''
+      headers = {}
+
+      method, path, query_string = /^([A-Z]+) ([^?\s]+)(?:\?(\S*))?/.match(input.readline)[1..3]
+
+      while !input.eof and (line = input.readline.chomp) != ''
+        headers.merge! [line.split(/:\s*/, 2)].to_h
+      end
+
+      body = input.read unless input.eof
+
+      [method, path, query_string, headers, body]
+    end
+
+  end
+end

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

@@ -0,0 +1,58 @@
+module Netfira::WebConnect
+
+  class Schema::Table
+
+    attr_reader :klass
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def singular
+      @singular ||= klass.name.demodulize
+    end
+
+    def plural
+      @plural ||= singular.pluralize
+    end
+
+    def primary_key
+      @primary_key ||= klass.origin_key
+    end
+
+    def localize
+      @localize ||= l10n_columns.keys.map(&:to_sym)
+    end
+
+    IGNORE_COLUMNS = %w[id shop_id created_at updated_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
+    end
+
+    def as_json(options)
+      @json ||= {
+          columns:    columns.map { |name, type| [name.to_s.camelize(:lower), type] }.to_h,
+          singular:   singular,
+          primaryKey: [primary_key.to_s.camelize(:lower)],
+          localize:   l10n_columns.keys.map{ |k| k.camelize :lower }
+      }
+    end
+
+    private
+
+    def l10n_columns
+      @l10n_columns ||= klass.has_languages? ? l10n_filtered_columns_hash : {}
+    end
+
+    IGNORE_L10N_COLUMNS = %w[id language]
+
+    def l10n_filtered_columns_hash
+      klass::Translation.columns_hash.reject do |k|
+        k == "#{klass.single_name}_id" or IGNORE_L10N_COLUMNS.include? k
+      end
+    end
+
+  end
+
+end

data/lib/netfira/web_connect/schema.rb

@@ -0,0 +1,22 @@
+module Netfira::WebConnect
+
+  # This class reflects the database's schema
+  class Schema < Hash
+
+    def initialize
+      classes = Models.constants.map{ |c| Models.const_get c }
+      classes.select!{ |klass| klass < Model::Record }
+      merge! classes.map{ |klass| [klass, Table.new(klass)] }.to_h
+    end
+
+    def as_json(options)
+      map do |klass, table|
+        [klass.name.demodulize.pluralize, table.as_json(options)]
+      end.to_h
+    end
+
+  end
+
+end
+
+require_relative 'schema/table'

data/lib/netfira/web_connect/version.rb

@@ -0,0 +1,5 @@
+module Netfira
+  module WebConnect
+    VERSION = '0.1.0'
+  end
+end

data/lib/netfira/web_connect.rb

@@ -0,0 +1,82 @@
+require 'yaml'
+require 'pathname'
+require 'active_record'
+require 'locale'
+
+require_relative 'web_connect/model'
+
+module Netfira
+  module WebConnect
+    ROOT = Pathname(__FILE__).parent
+
+    def self.configure(input = nil, **options)
+      if Hash === input
+        @config = Configuration.new(input)
+      elsif String === input
+        @config = Configuration.new(YAML.parse input)
+      elsif input.respond_to? :read
+        @config = Configuration.new(YAML.parse_stream input)
+      elsif input.nil?
+        @config ||= Configuration.new
+      else
+        raise "You cannot configure WebConnect with an instance of #{input.class}"
+      end
+      @config.materialize_when_db_changed = !options[:skip_materialization]
+      yield @config if block_given?
+    end
+
+    def self.db_table_prefix(string = '')
+      [@config.db_table_prefix, string].join.to_sym
+    end
+
+    def self.db_table_l10n_suffix(table_name = '')
+      :"#{table_name}_l10n"
+    end
+
+    def self.schema_migrations_table_name
+      db_table_prefix('schema_migrations').to_s
+    end
+
+    def self.logger
+      @config.logger || null_logger
+    end
+
+    def self.system_locale
+      @system_locale ||= Locale.current.to_simple.to_s
+    end
+
+    def self.file_store
+      @config.file_store || {}
+    end
+
+    def self.authenticator
+      @config.authenticator
+    end
+
+    def self.anonymous_shop
+      @anonymous_shop ||= Models::Shop.find(0)
+    end
+
+    def self.schema
+      @schema ||= Schema.new if @config
+    end
+
+    private
+
+    def self.null_logger
+      @null_logger ||= Logger.new nil
+    end
+
+  end
+end
+
+require_relative 'web_connect/events'
+
+require_relative 'web_connect/rack_app'
+require_relative 'web_connect/request_filter'
+require_relative 'web_connect/migration'
+require_relative 'web_connect/version'
+require_relative 'web_connect/models'
+require_relative 'web_connect/components'
+require_relative 'web_connect/configuration'
+require_relative 'web_connect/schema'

data/lib/netfira.rb

@@ -0,0 +1,10 @@
+require 'i18n'
+
+# Suppress a deprecation warning from (presumably) ActiveSupport
+# TODO: get to the bottom of this maybe
+I18n.config.enforce_available_locales = true
+
+module Netfira
+end
+
+require_relative 'netfira/web_connect'

data/lib/web_connect.rb

@@ -0,0 +1 @@
+require_relative 'netfira'

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification
+name: web-connect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neil E. Pearson
+- Gerard (Gerry) Caulfield
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: locale
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: fastimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: |
+  This is a Ruby version of Netfira's WebConnect server-side library
+email:
+- neil@helium.net.au
+- gerard@caulfield.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/netfira.rb
+- lib/netfira/web_connect.rb
+- lib/netfira/web_connect/components.rb
+- lib/netfira/web_connect/components/checksum.rb
+- lib/netfira/web_connect/components/guid.rb
+- lib/netfira/web_connect/components/octa_word.rb
+- lib/netfira/web_connect/configuration.rb
+- lib/netfira/web_connect/db_schema/20140514_support.rb
+- lib/netfira/web_connect/db_schema/20140515_alpha.rb
+- lib/netfira/web_connect/events.rb
+- lib/netfira/web_connect/migration.rb
+- lib/netfira/web_connect/migration/base_methods.rb
+- lib/netfira/web_connect/migration/refinements.rb
+- lib/netfira/web_connect/model.rb
+- lib/netfira/web_connect/model/record.rb
+- lib/netfira/web_connect/model/record/digests.rb
+- lib/netfira/web_connect/model/record/events.rb
+- lib/netfira/web_connect/model/record/file_record.rb
+- lib/netfira/web_connect/model/record/materialization.rb
+- lib/netfira/web_connect/model/record/relations.rb
+- lib/netfira/web_connect/model/record/sendable.rb
+- lib/netfira/web_connect/model/record/serializer.rb
+- lib/netfira/web_connect/model/record/translated_string.rb
+- 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/relation.rb
+- lib/netfira/web_connect/model/relation/events.rb
+- lib/netfira/web_connect/model/support.rb
+- lib/netfira/web_connect/models.rb
+- lib/netfira/web_connect/models/image.rb
+- lib/netfira/web_connect/models/order.rb
+- lib/netfira/web_connect/models/order_line.rb
+- lib/netfira/web_connect/models/support/setting.rb
+- lib/netfira/web_connect/models/support/shop.rb
+- lib/netfira/web_connect/models/support/shop/settings.rb
+- lib/netfira/web_connect/models/support/table.rb
+- lib/netfira/web_connect/rack_app.rb
+- lib/netfira/web_connect/rack_app/action.rb
+- 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/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
+- lib/netfira/web_connect/request_filter.rb
+- lib/netfira/web_connect/schema.rb
+- lib/netfira/web_connect/schema/table.rb
+- lib/netfira/web_connect/version.rb
+- lib/web_connect.rb
+homepage: http://www.netfira.com/
+licenses:
+- proprietary
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Netfira's WebConnect Library
+test_files: []