apicasso 0.2.16 → 0.3.0

data/app/controllers/concerns/orderable.rb

@@ -1,45 +1,45 @@
-# frozen_string_literal: true
-
-# This concern is used to provide abstract ordering based on `params[:sort]`
-module Orderable
-  extend ActiveSupport::Concern
-  SORT_ORDER = { '+' => :asc, '-' => :desc }.freeze
-
-  # A list of the param names that can be used for ordering the model list
-  def ordering_params(params)
-    # For example it retrieves a list of orders in descending order of total_value.
-    # Within a specific total_value, older orders are ordered first
-    #
-    # GET /orders?sort=-total_value,created_at
-    # ordering_params(params) # => { total_value: :desc, created_at: :asc }
-    #
-    # Usage:
-    # Order.order(ordering_params(params))
-    ordering = {}
-    params[:sort].try(:split, ',').try(:each) do |attr|
-      parsed_attr = parse_attr attr
-      if model.attribute_names.include?(parsed_attr)
-        ordering[parsed_attr] = SORT_ORDER[parse_sign attr]
-      end
-    end
-    ordering
-  end
-
-  private
-
-  # Parsing of attributes to avoid empty starts in case browser passes "+" as " "
-  def parse_attr(attr)
-    return attr.gsub(/^\ (.*)/, '\1') if attr.starts_with?(' ')
-    return attr[1..-1] if attr.starts_with?('+') || attr.starts_with?('-')
-    attr
-  end
-
-  # Ordering sign parse, which separates
-  def parse_sign(attr)
-    attr =~ /\A[+-]/ ? attr.slice!(0) : '+'
-  end
-
-  def model
-    (params[:resource] || params[:nested] || controller_name).classify.constantize
-  end
-end
+# frozen_string_literal: true
+
+# This concern is used to provide abstract ordering based on `params[:sort]`
+module Orderable
+  extend ActiveSupport::Concern
+  SORT_ORDER = { '+' => :asc, '-' => :desc }.freeze
+
+  # A list of the param names that can be used for ordering the model list
+  def ordering_params(params)
+    # For example it retrieves a list of orders in descending order of total_value.
+    # Within a specific total_value, older orders are ordered first
+    #
+    # GET /orders?sort=-total_value,created_at
+    # ordering_params(params) # => { total_value: :desc, created_at: :asc }
+    #
+    # Usage:
+    # Order.order(ordering_params(params))
+    ordering = {}
+    params[:sort].try(:split, ',').try(:each) do |attr|
+      parsed_attr = parse_attr attr
+      if model.attribute_names.include?(parsed_attr)
+        ordering[parsed_attr] = SORT_ORDER[parse_sign attr]
+      end
+    end
+    ordering
+  end
+
+  private
+
+  # Parsing of attributes to avoid empty starts in case browser passes "+" as " "
+  def parse_attr(attr)
+    return attr.gsub(/^\ (.*)/, '\1') if attr.starts_with?(' ')
+    return attr[1..-1] if attr.starts_with?('+') || attr.starts_with?('-')
+    attr
+  end
+
+  # Ordering sign parse, which separates
+  def parse_sign(attr)
+    attr =~ /\A[+-]/ ? attr.slice!(0) : '+'
+  end
+
+  def model
+    (params[:resource] || params[:nested] || controller_name).classify.constantize
+  end
+end

data/app/models/apicasso/ability.rb

@@ -1,40 +1,38 @@
-# frozen_string_literal: true
-
-module Apicasso
-  # Ability to parse a scope object from Apicasso::Key
-  class Ability
-    include CanCan::Ability
-
-    def initialize(key)
-      key ||= Apicasso::Key.new
-      cannot :manage, :all
-      cannot :read, :all
-      key.scope.each do |permission, klasses_clearances|
-        klasses_clearances.each do |klasses|
-          klasses.each do |klass, clearance|
-            if clearance == true
-              # Usage:
-              # To have a key reading all channels and all accouts
-              # you would have a scope:
-              # => `{read: [{channel: true}, {accout: true}]}`
-              can permission.to_sym, klass.underscore.to_sym
-              can permission.to_sym, klass.classify.constantize
-            elsif clearance.class == Hash
-              # Usage:
-              # To have a key reading all banners from a channel with id 999
-              # you would have a scope:
-              # => `{read: [{banner: {owner_id: [999]}}]}`
-              can permission.to_sym,
-                  klass.underscore.to_sym
-              clearance.each do |by_field, values|
-                can permission.to_sym,
-                    klass.classify.constantize,
-                    by_field => values
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Apicasso
+  # Ability to parse a scope object from Apicasso::Key
+  class Ability
+    include CanCan::Ability
+
+    def initialize(key)
+      key ||= Apicasso::Key.new
+      cannot :manage, :all
+      cannot :read, :all
+      key.scope.each do |permission, klasses_clearances|
+        klasses_clearances.each do |klass, clearance|
+          if clearance == true
+            # Usage:
+            # To have a key reading all channels and all accouts
+            # you would have a scope:
+            # => `{read: {channel: true, accout: true}}`
+            can permission.to_sym, klass.underscore.to_sym
+            can permission.to_sym, klass.classify.constantize
+          elsif clearance.class == Hash
+            # Usage:
+            # To have a key reading all banners from a channel with id 999
+            # you would have a scope:
+            # => `{read: {banner: {owner_id: [999]}}}`
+            can permission.to_sym,
+                klass.underscore.to_sym
+            clearance.each do |by_field, values|
+              can permission.to_sym,
+                  klass.classify.constantize,
+                  by_field.to_sym => values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/apicasso/application_record.rb

@@ -1,6 +1,6 @@
-module Apicasso
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-    self.table_name_prefix = 'apicasso_'
-  end
-end
+module Apicasso
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+    self.table_name_prefix = 'apicasso_'
+  end
+end

data/app/models/apicasso/key.rb

@@ -1,25 +1,25 @@
-# frozen_string_literal: true
-
-require 'securerandom'
-module Apicasso
-  # A model to abstract API access, with scope options, token generation, request limiting
-  class Key < ApplicationRecord
-    before_create :set_auth_token
-
-    private
-
-    # Method that generates `SecureRandom.uuid` as token until
-    # an unique one has been acquired
-    def set_auth_token
-      loop do
-        self.token = generate_auth_token
-        break unless self.class.exists?(token: token)
-      end
-    end
-
-    # RFC4122 style token
-    def generate_auth_token
-      SecureRandom.uuid.delete('-')
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'securerandom'
+module Apicasso
+  # A model to abstract API access, with scope options, token generation, request limiting
+  class Key < ApplicationRecord
+    before_create :set_auth_token
+
+    private
+
+    # Method that generates `SecureRandom.uuid` as token until
+    # an unique one has been acquired
+    def set_auth_token
+      loop do
+        self.token = generate_auth_token
+        break unless self.class.exists?(token: token)
+      end
+    end
+
+    # RFC4122 style token
+    def generate_auth_token
+      SecureRandom.uuid.delete('-')
+    end
+  end
+end

data/app/models/apicasso/request.rb

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-module Apicasso
-  # A model to abstract API access, with scope options, token generation, request limiting
-  class Request < ApplicationRecord
-    belongs_to :api_key, class_name: 'Apicasso::Key'
-  end
-end
+# frozen_string_literal: true
+
+module Apicasso
+  # A model to abstract API access, with scope options, token generation, request limiting
+  class Request < ApplicationRecord
+    belongs_to :api_key, class_name: 'Apicasso::Key'
+  end
+end

data/config/routes.rb

@@ -1,14 +1,14 @@
-Apicasso::Engine.routes.draw do
-  scope module: :apicasso do
-    resources :apidocs, only: [:index]
-    get '/:resource/', to: 'crud#index', via: :get
-    match '/:resource/', to: 'crud#create', via: :post
-    get '/:resource/:id', to: 'crud#show', via: :get
-    match '/:resource/:id', to: 'crud#update', via: :patch
-    match '/:resource/:id', to: 'crud#destroy', via: :delete
-    match '/:resource/:id/:nested/', to: 'crud#nested_index', via: :get
-    match '/:resource/', to: 'crud#schema', via: :options
-    match '/:resource/:id', to: 'crud#schema', via: :options
-    match '/:resource/:id/:nested/', to: 'crud#schema', via: :options
-  end
-end
+Apicasso::Engine.routes.draw do
+  scope module: :apicasso do
+    resources :apidocs, only: [:index]
+    get '/:resource/', to: 'crud#index', via: :get
+    match '/:resource/', to: 'crud#create', via: :post
+    get '/:resource/:id', to: 'crud#show', via: :get
+    match '/:resource/:id', to: 'crud#update', via: :patch
+    match '/:resource/:id', to: 'crud#destroy', via: :delete
+    match '/:resource/:id/:nested/', to: 'crud#nested_index', via: :get
+    match '/:resource/', to: 'crud#schema', via: :options
+    match '/:resource/:id', to: 'crud#schema', via: :options
+    match '/:resource/:id/:nested/', to: 'crud#schema', via: :options
+  end
+end

data/db/migrate/20180826141433_create_apicasso_tables.rb

@@ -1,17 +1,17 @@
-class CreateApicassoTables < ActiveRecord::Migration[5.0]
-  def change
-    create_table :apicasso_keys, id: :uuid do |t|
-      t.json :scope
-      t.integer :scope_type
-      t.json :request_limiting
-      t.text :token
-      t.datetime :deleted_at
-      t.timestamps null: false
-    end
-    create_table :apicasso_requests, id: :uuid do |t|
-      t.text :api_key_id
-      t.json :object
-      t.timestamps null: false
-    end
-  end
-end
+class CreateApicassoTables < ActiveRecord::Migration[5.0]
+  def change
+    create_table :apicasso_keys, id: :uuid do |t|
+      t.json :scope
+      t.integer :scope_type
+      t.json :request_limiting
+      t.text :token
+      t.datetime :deleted_at
+      t.timestamps null: false
+    end
+    create_table :apicasso_requests, id: :uuid do |t|
+      t.text :api_key_id
+      t.json :object
+      t.timestamps null: false
+    end
+  end
+end

data/lib/apicasso/engine.rb

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-
-module Apicasso
-  class Engine < ::Rails::Engine
-  end
-end
+# frozen_string_literal: true
+
+module Apicasso
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/apicasso/version.rb

@@ -1,3 +1,3 @@
-module Apicasso
-  VERSION = '0.2.16'
-end
+module Apicasso
+  VERSION = '0.3.0'
+end

data/lib/apicasso.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal: true
-
-require 'apicasso/version'
-require 'apicasso/engine'
-require 'apicasso/active_record_extension'
-
-module Apicasso
-  # Your code goes here...
-end
+# frozen_string_literal: true
+
+require 'apicasso/version'
+require 'apicasso/engine'
+require 'apicasso/active_record_extension'
+
+module Apicasso
+  # Your code goes here...
+end

data/lib/generators/apicasso/install/install_generator.rb

@@ -1,25 +1,25 @@
-require 'rails/generators/migration'
-
-module Apicasso
-  module Generators
-    class InstallGenerator < ::Rails::Generators::Base
-      include Rails::Generators::Migration
-      source_root File.expand_path('../templates', __FILE__)
-      desc 'Add the required migrations to run APIcasso'
-
-      def self.next_migration_number(path)
-        if @prev_migration_nr
-          @prev_migration_nr += 1
-        else
-          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-        end
-        @prev_migration_nr.to_s
-      end
-
-      def copy_migrations
-        migration_template 'create_apicasso_tables.rb',
-                           'db/migrate/create_apicasso_tables.rb'
-      end
-    end
-  end
-end
+require 'rails/generators/migration'
+
+module Apicasso
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc 'Add the required migrations to run APIcasso'
+
+      def self.next_migration_number(path)
+        if @prev_migration_nr
+          @prev_migration_nr += 1
+        else
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template 'create_apicasso_tables.rb',
+                           'db/migrate/create_apicasso_tables.rb'
+      end
+    end
+  end
+end

data/lib/generators/apicasso/install/templates/create_apicasso_tables.rb

@@ -1,17 +1,17 @@
-class CreateApicassoTables < ActiveRecord::Migration[5.0]
-  def change
-    create_table :apicasso_keys, id: :uuid do |t|
-      t.json :scope
-      t.integer :scope_type
-      t.json :request_limiting
-      t.text :token
-      t.datetime :deleted_at
-      t.timestamps null: false
-    end
-    create_table :apicasso_requests, id: :uuid do |t|
-      t.text :api_key_id
-      t.json :object
-      t.timestamps null: false
-    end
-  end
-end
+class CreateApicassoTables < ActiveRecord::Migration[5.0]
+  def change
+    create_table :apicasso_keys, id: :uuid do |t|
+      t.json :scope
+      t.integer :scope_type
+      t.json :request_limiting
+      t.text :token
+      t.datetime :deleted_at
+      t.timestamps null: false
+    end
+    create_table :apicasso_requests, id: :uuid do |t|
+      t.text :api_key_id
+      t.json :object
+      t.timestamps null: false
+    end
+  end
+end

data/lib/tasks/apicasso_tasks.rake

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apicasso
 version: !ruby/object:Gem::Version
-  version: 0.2.16
+  version: 0.3.0
 platform: ruby
 authors:
 - Fernando Bellincanta
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: An abstract API design as a mountable engine