forest_liana 1.4.7 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdc8fcb5df5a924d7903d9105b26b30810ef6a52
-  data.tar.gz: cd688dccec28feaf5a66f0ea47b7c0bed89ee051
+  metadata.gz: 370f07e1de98a6ce3327d97c481023c434f85b45
+  data.tar.gz: bcb19bdd6901d1e41fea931f89d9da81c52ffdde
 SHA512:
-  metadata.gz: 0ea7d3bb580c5cee0a84f80aff39d3d1c44d65c4ecdc2b694f0531e36c3edc1e12e0591b5a2c64838e04081675fcc09672a56323dc026a43ebcde19f7f5b3ddc
-  data.tar.gz: 0832ca416bd830169ea4bb3926fa839a0b245d4e8ea0c1d13732b4cbe9cd794c8dad561ad2ac6bb12496eeb209637f91e12759559830b424c229a22592e81534
+  metadata.gz: 9e30e668b9116aaaa701bd0046747c33dac6cc22e806970af081a34b346f7bc6810a4df5ec4f50d4013d9dc6ec93af3d9bc9eefdbd97e5599e1c7829c7be8efe
+  data.tar.gz: 0aa6c921a2fab719a0425b5fc8f75578c733c71a47c5e392de4ee69e12d32dea561f77eaf6516a7f7e4aa2742ece9aad82974f5114dd16b8f28f0af1d53130fe

data/app/controllers/forest_liana/application_controller.rb

@@ -41,7 +41,7 @@ module ForestLiana
       if request.headers['Authorization']
         begin
           token = request.headers['Authorization'].split.second
-          @jwt_decoded_token = JWT.decode(token, ForestLiana.auth_key, true, {
+          @jwt_decoded_token = JWT.decode(token, ForestLiana.auth_secret, true, {
             algorithm: 'HS256',
             leeway: 30
           }).try(:first)

data/app/controllers/forest_liana/sessions_controller.rb

@@ -55,7 +55,7 @@ module ForestLiana
     end
 
     def encode_token(user)
-      if ForestLiana.auth_key.nil?
+      if ForestLiana.auth_secret.nil?
         @error_message = "Your Forest auth key seems to be missing. Can " \
           "you check that you properly set a Forest auth key in the " \
           "forest_liana initializer?"
@@ -82,7 +82,7 @@ module ForestLiana
               }
             }
           }
-        }, ForestLiana.auth_key, 'HS256')
+        }, ForestLiana.auth_secret, 'HS256')
       end
     end
   end

data/app/helpers/forest_liana/adapter_helper.rb

@@ -0,0 +1,9 @@
+module ForestLiana
+  module AdapterHelper
+    def self.format_column_name(table_name, column_name)
+      quoted_table_name = ActiveRecord::Base.connection.quote_table_name(table_name)
+      quoted_column_name = ActiveRecord::Base.connection.quote_column_name(column_name)
+      "#{quoted_table_name}.#{quoted_column_name}"
+    end
+  end
+end

data/app/models/forest_liana/model/collection.rb

@@ -4,11 +4,13 @@ class ForestLiana::Model::Collection
   include ActiveModel::Serialization
   extend ActiveModel::Naming
 
-  attr_accessor :name, :fields, :actions, :only_for_relationships, :is_virtual,
-    :is_read_only, :is_searchable, :display_name, :icon, :pagination_type
+  attr_accessor :name, :fields, :actions, :segments, :only_for_relationships,
+    :is_virtual, :is_read_only, :is_searchable, :display_name, :icon,
+    :pagination_type
 
   def initialize(attributes = {})
     @actions = []
+    @segments = []
     @is_searchable = true
     @is_read_only = false
 

data/app/models/forest_liana/model/segment.rb

@@ -0,0 +1,20 @@
+class ForestLiana::Model::Segment
+  include ActiveModel::Validations
+  include ActiveModel::Conversion
+  include ActiveModel::Serialization
+  extend ActiveModel::Naming
+
+  attr_accessor :id, :name, :scope, :where
+
+  def initialize(attributes = {}, &block)
+    attributes.each do |name, value|
+      send("#{name}=", value)
+    end
+    
+    @where = block if block
+  end
+
+  def persisted?
+    false
+  end
+end

data/app/serializers/forest_liana/collection_serializer.rb

@@ -17,6 +17,10 @@ class ForestLiana::CollectionSerializer
     object.actions
   end
 
+  has_many :segments do
+    object.segments
+  end
+
   def relationship_related_link(attribute_name)
     nil
   end

data/app/serializers/forest_liana/segment_serializer.rb

@@ -0,0 +1,15 @@
+require 'jsonapi-serializers'
+
+class ForestLiana::SegmentSerializer
+  include JSONAPI::Serializer
+
+  attribute :name
+
+  def relationship_related_link(attribute_name)
+    nil
+  end
+
+  def relationship_self_link(attribute_name)
+    nil
+  end
+end

data/app/serializers/forest_liana/serializer_factory.rb

@@ -41,6 +41,8 @@ module ForestLiana
         "ForestLiana::CollectionSerializer"
       elsif active_record_class == ForestLiana::Model::Action
         "ForestLiana::ActionSerializer"
+      elsif active_record_class == ForestLiana::Model::Segment
+        "ForestLiana::SegmentSerializer"
       else
         class_name = active_record_class.table_name.classify
         module_name = class_name.deconstantize

data/app/services/forest_liana/allowed_users_getter.rb

@@ -9,7 +9,7 @@ module ForestLiana
         http.start do |client|
           request = Net::HTTP::Get.new(uri.path)
           request['Content-Type'] = 'application/json'
-          request['forest-secret-key'] = ForestLiana.secret_key
+          request['forest-secret-key'] = ForestLiana.env_secret
           response = client.request(request)
 
           if response.is_a?(Net::HTTPOK)
@@ -23,7 +23,7 @@ module ForestLiana
           elsif response.is_a?(Net::HTTPNotFound)
             FOREST_LOGGER.error "Cannot retrieve the project you\'re trying " \
               "to unlock. Can you check that you properly copied the Forest " \
-              "secret key in the forest_liana initializer?"
+              "env_secret in the forest_liana initializer?"
           else
             FOREST_LOGGER.error "Cannot retrieve any users for the project " \
               "you\'re trying to unlock. An error occured in Forest API."

data/app/services/forest_liana/has_many_associator.rb

@@ -12,8 +12,8 @@ module ForestLiana
       associated_records = @resource.find(@params[:id]).send(@association.name)
 
       if @data.is_a?(Array)
-        @data.each do |record_deleted|
-          associated_records << @association.klass.find(record_deleted[:id])
+        @data.each do |record_added|
+          associated_records << @association.klass.find(record_added[:id])
         end
       end
     end

data/app/services/forest_liana/has_many_getter.rb

@@ -7,12 +7,6 @@ module ForestLiana
       @field_names_requested = field_names_requested
     end
 
-    def field_names_requested
-      return nil unless @params[:fields] && @params[:fields][@association.table_name]
-      @params[:fields][@association.table_name].split(',')
-                                            .map { |name| name.to_sym }
-    end
-
     def perform
       @records = @resource
         .unscoped
@@ -49,6 +43,12 @@ module ForestLiana
 
     private
 
+    def field_names_requested
+      return nil unless @params[:fields] && @params[:fields][@association.table_name]
+      @params[:fields][@association.table_name].split(',')
+                                            .map { |name| name.to_sym }
+    end
+
     def association_table_name
       @resource.reflect_on_association(@params[:association_name])
         .try(:table_name)
@@ -66,12 +66,10 @@ module ForestLiana
     end
 
     def limit
-      return 10 unless pagination?
-
-      if @params[:page][:size]
+      if @params[:page] && @params[:page][:size]
         @params[:page][:size].to_i
       else
-        10
+        5
       end
     end
 

data/app/services/forest_liana/resources_getter.rb

@@ -4,33 +4,21 @@ module ForestLiana
       @resource = resource
       @params = params
       @field_names_requested = field_names_requested
-    end
-
-    def field_names_requested
-      return nil unless @params[:fields] && @params[:fields][@resource.table_name]
 
-      associations_for_query = []
+      get_segment()
+    end
 
-      # NOTICE: Populate the necessary associations for filters
-      if @params[:filter]
-        @params[:filter].each do |field, values|
-          if field.include? ':'
-            associations_for_query << field.split(':').first.to_sym
-          end
-        end
-      end
+    def perform
+      @records = @resource.unscoped
 
-      if @params[:sort] && @params[:sort].include?('.')
-        associations_for_query << @params[:sort].split('.').first.to_sym
+      if @segment && @segment.scope
+        @records = @records.send(@segment.scope)
+      elsif @segment && @segment.where
+        @records = @records.where(@segment.where.call())
       end
 
-      field_names = @params[:fields][@resource.table_name].split(',')
-                                              .map { |name| name.to_sym }
-      field_names | associations_for_query
-    end
+      @records = @records.eager_load(includes)
 
-    def perform
-      @records = @resource.unscoped.eager_load(includes)
       @records = search_query
       @sorted_records = sort_query
     end
@@ -57,6 +45,41 @@ module ForestLiana
 
     private
 
+    def get_segment
+      if @params[:segment]
+        current_collection = ForestLiana.apimap.find do |collection|
+          collection.name.to_s == @resource.table_name
+        end
+
+        @segment = current_collection.segments.find do |segment|
+          segment.name == @params[:segment]
+        end
+      end
+    end
+
+    def field_names_requested
+      return nil unless @params[:fields] && @params[:fields][@resource.table_name]
+
+      associations_for_query = []
+
+      # NOTICE: Populate the necessary associations for filters
+      if @params[:filter]
+        @params[:filter].each do |field, values|
+          if field.include? ':'
+            associations_for_query << field.split(':').first.to_sym
+          end
+        end
+      end
+
+      if @params[:sort] && @params[:sort].include?('.')
+        associations_for_query << @params[:sort].split('.').first.to_sym
+      end
+
+      field_names = @params[:fields][@resource.table_name].split(',')
+                                              .map { |name| name.to_sym }
+      field_names | associations_for_query
+    end
+
     def search_query
       SearchQueryBuilder.new(@records, @params, includes).perform
     end
@@ -96,7 +119,8 @@ module ForestLiana
           .find {|a| a.name == ref.to_sym }
 
         if association
-          "\"#{association.table_name}\".\"#{field}\""
+          ForestLiana::AdapterHelper
+            .format_column_name(association.table_name, field)
         else
           param
         end

data/app/services/forest_liana/search_query_builder.rb

@@ -24,11 +24,16 @@ module ForestLiana
       @records
     end
 
+    def format_column_name(table_name, column_name)
+      ForestLiana::AdapterHelper.format_column_name(table_name, column_name)
+    end
+
     def search_param
       if @params[:search]
         conditions = []
 
         @resource.columns.each_with_index do |column, index|
+          column_name = format_column_name(@resource.table_name, column.name)
           if column.name == 'id'
             if column.type == :integer
               conditions << "#{@resource.table_name}.id =
@@ -41,13 +46,11 @@ module ForestLiana
           elsif @resource.respond_to?(:defined_enums) &&
             @resource.defined_enums.has_key?(column.name) &&
             !@resource.defined_enums[column.name][@params[:search].downcase].nil?
-            conditions << "\"#{@resource.table_name}\".\"#{column.name}\" =
+            conditions << "#{column_name} =
               #{@resource.defined_enums[column.name][@params[:search].downcase]}"
-          elsif !column.array && (column.type == :string ||
-                                  column.type == :text)
-            conditions <<
-              "LOWER(\"#{@resource.table_name}\".\"#{column.name}\") LIKE " +
-              "'%#{@params[:search].downcase}%'"
+          elsif !(column.respond_to?(:array) && column.array) &&
+            (column.type == :string || column.type == :text)
+            conditions << "LOWER(#{column_name}) LIKE '%#{@params[:search].downcase}%'"
           end
         end
 
@@ -55,9 +58,11 @@ module ForestLiana
           if @includes.include? association.to_sym
             resource = @resource.reflect_on_association(association.to_sym)
             resource.klass.columns.each do |column|
-              if !column.array && (column.type == :string || column.type == :text)
-                conditions <<
-                  "LOWER(\"#{resource.table_name}\".\"#{column.name}\") LIKE " +
+              if !(column.respond_to?(:array) && column.array) &&
+                (column.type == :string || column.type == :text)
+                column_name = format_column_name(resource.table_name,
+                  column.name)
+                conditions << "LOWER(#{column_name}) LIKE " +
                   "'%#{@params[:search].downcase}%'"
               end
             end

data/lib/forest_liana.rb

@@ -7,8 +7,12 @@ module ForestLiana
   module UserSpace
   end
 
+  # NOTICE: Deprecated secret value names
   mattr_accessor :secret_key
   mattr_accessor :auth_key
+
+  mattr_accessor :env_secret
+  mattr_accessor :auth_secret
   mattr_accessor :integrations
   mattr_accessor :apimap
   mattr_accessor :allowed_users

data/lib/forest_liana/bootstraper.rb

@@ -6,6 +6,15 @@ module ForestLiana
 
       @integration_stripe_valid = false
       @integration_intercom_valid = false
+
+      if ForestLiana.secret_key && ForestLiana.auth_key
+        FOREST_LOGGER.warn "DEPRECATION WARNING: The use of " \
+          "ForestLiana.secret_key and ForestLiana.auth_key " \
+          "(config/initializers/forest_liana.rb) is deprecated. Please use " \
+          "ForestLiana.env_secret and ForestLiana.auth_secret instead."
+        ForestLiana.env_secret = ForestLiana.secret_key
+        ForestLiana.auth_secret = ForestLiana.auth_key
+      end
     end
 
     def perform
@@ -13,7 +22,7 @@ module ForestLiana
       check_integrations_setup
       create_serializers
 
-      if ForestLiana.secret_key
+      if ForestLiana.env_secret
         create_apimap
         require_lib_forest_liana
         send_apimap
@@ -136,14 +145,14 @@ module ForestLiana
     end
 
     def send_apimap
-      if ForestLiana.secret_key && ForestLiana.secret_key.length != 64
-        FOREST_LOGGER.error "Your secret key does not seem to be correct. " \
+      if ForestLiana.env_secret && ForestLiana.env_secret.length != 64
+        FOREST_LOGGER.error "Your env_secret does not seem to be correct. " \
           "Can you check on Forest that you copied it properly in the " \
           "forest_liana initializer?"
       else
         json = JSONAPI::Serializer.serialize(ForestLiana.apimap, {
           is_collection: true,
-          include: ['actions'],
+          include: ['actions', 'segments'],
           meta: { liana: 'forest-rails', liana_version: liana_version }
         })
 
@@ -155,13 +164,13 @@ module ForestLiana
             request = Net::HTTP::Post.new(uri.path)
             request.body = json.to_json
             request['Content-Type'] = 'application/json'
-            request['forest-secret-key'] = ForestLiana.secret_key
+            request['forest-secret-key'] = ForestLiana.env_secret
             response = client.request(request)
 
             # NOTICE: HTTP 404 Error
             if response.is_a?(Net::HTTPNotFound)
               FOREST_LOGGER.error "Cannot find the project related to the " \
-                "secret key you configured. Can you check on Forest that you " \
+                "env_secret you configured. Can you check on Forest that you " \
                 "copied it properly in the forest_liana initializer?"
             # NOTICE: HTTP 400 Error
             elsif response.is_a?(Net::HTTPBadRequest)

data/lib/forest_liana/collection.rb

@@ -19,6 +19,12 @@ module ForestLiana::Collection
       model.actions << ForestLiana::Model::Action.new(opts)
     end
 
+    def segment(name, opts = {}, &block)
+      opts[:id] = "#{self.collection_name.to_s}.#{name}"
+      opts[:name] = name
+      model.segments << ForestLiana::Model::Segment.new(opts, &block)
+    end
+
     def field(name, opts, &block)
       opts[:read_only] = true unless opts.has_key?(:read_only)
       opts[:is_searchable] = false unless opts.has_key?(:is_searchable)

data/lib/forest_liana/engine.rb

@@ -45,7 +45,7 @@ module ForestLiana
         app.eager_load!
 
         # NOTICE: Do not run the code below on rails g forest_liana:install.
-        Bootstraper.new(app).perform if ForestLiana.secret_key
+        Bootstraper.new(app).perform if ForestLiana.env_secret || ForestLiana.secret_key
       end
     end
   end

data/lib/forest_liana/version.rb

@@ -1,3 +1,3 @@
 module ForestLiana
-  VERSION = "1.4.7"
+  VERSION = "1.5.0"
 end

data/lib/generators/forest_liana/install_generator.rb

@@ -4,11 +4,35 @@ module ForestLiana
   class InstallGenerator < Rails::Generators::Base
     desc 'Forest Rails Liana installation generator'
 
+    argument :env_secret, type: :string, required: true, desc: 'required', banner: 'env_secret'
+
     def install
-      secret_key = ask('What\'s your project secret key?')
-      route("mount ForestLiana::Engine => '/forest'")
+      route "mount ForestLiana::Engine => '/forest'"
+
       initializer 'forest_liana.rb' do
-        "ForestLiana.secret_key = '#{secret_key}'\nForestLiana.auth_key = '#{SecureRandom.urlsafe_base64}'"
+        "ForestLiana.env_secret = Rails.application.secrets.forest_env_secret" +
+        "\nForestLiana.auth_secret = Rails.application.secrets.forest_auth_secret"
+      end
+
+      auth_secret = SecureRandom.urlsafe_base64
+
+      puts "\nForest generated a random authentication secret to secure the " +
+        "data access of your local project.\nYou can change it at any time in " +
+        "your config/secrets.yml file.\n\n"
+
+      inject_into_file 'config/secrets.yml', after: "development:" do
+        "\n  forest_env_secret: #{env_secret}" +
+        "\n  forest_auth_secret: #{auth_secret}"
+      end
+
+      inject_into_file 'config/secrets.yml', after: "staging:", force: true do
+        "\n  forest_env_secret: <%= ENV[\"FOREST_ENV_SECRET\"] %>" +
+        "\n  forest_auth_secret: <%= ENV[\"FOREST_AUTH_SECRET\"] %>"
+      end
+
+      inject_into_file 'config/secrets.yml', after: "production:", force: true do
+        "\n  forest_env_secret: <%= ENV[\"FOREST_ENV_SECRET\"] %>" +
+        "\n  forest_auth_secret: <%= ENV[\"FOREST_AUTH_SECRET\"] %>"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forest_liana
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.5.0
 platform: ruby
 authors:
 - Sandro Munda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -145,14 +145,17 @@ files:
 - app/controllers/forest_liana/stats_controller.rb
 - app/controllers/forest_liana/stripe_controller.rb
 - app/deserializers/forest_liana/resource_deserializer.rb
+- app/helpers/forest_liana/adapter_helper.rb
 - app/helpers/forest_liana/application_helper.rb
 - app/models/forest_liana/model/action.rb
 - app/models/forest_liana/model/collection.rb
+- app/models/forest_liana/model/segment.rb
 - app/models/forest_liana/model/stat.rb
 - app/serializers/forest_liana/action_serializer.rb
 - app/serializers/forest_liana/collection_serializer.rb
 - app/serializers/forest_liana/intercom_attribute_serializer.rb
 - app/serializers/forest_liana/intercom_conversation_serializer.rb
+- app/serializers/forest_liana/segment_serializer.rb
 - app/serializers/forest_liana/serializer_factory.rb
 - app/serializers/forest_liana/session_serializer.rb
 - app/serializers/forest_liana/stat_serializer.rb
@@ -199,7 +202,6 @@ files:
 - lib/forest_liana/engine.rb
 - lib/forest_liana/version.rb
 - lib/generators/forest_liana/install_generator.rb
-- lib/tasks/forest_tasks.rake
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js

data/lib/tasks/forest_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :forest do
-#   # Task goes here
-# end