devise-activeresource 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7d274de54921072d3e0982020dac693705a1a221e1e8f009d08447bfd905580
+  data.tar.gz: 0c7c4c265c2fdcb27e53d03b6d72cc5b44739d0b954d2ed91f95c9df22e37679
+SHA512:
+  metadata.gz: e5104cae5f2f5724ada49676e477bdbb503fbabec125b716d115f482ed6bbd928965b5f48ec7aba86355f644591bcc22cd70acd3cc0b1a2f8171516a1be56db0
+  data.tar.gz: 678a4e131143f335900022ab042b09c4d0599aee2b819c7b71eed7999d6afdc40687dddf636d2d2961f59d45b1690507b0b21143df57bba160744dc6df5e4396

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Francisco Caiceo
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Devise::Activeresource
+`Devise::Activeresource` is an adapter that allows you to use [devise](https://github.com/heartcombo/devise) with [Active Resource](https://github.com/rails/activeresource) in your models. It supports `Devise >= 4.7.1` and `Active Resource 5.1`. It may work with earlier version of `devise` and `activeresource`, but it's not tested for those versions.
+
+## Usage
+In the `config/inititializer/devise.rb` file, replace the default orm adapter:
+```ruby
+  require 'devise/orm/active_record'
+```
+
+with the following:
+```ruby
+  require 'devise/orm/active_resource'
+```
+
+### Generators and API
+This gem does not provide model generators because `ActiveResource` models adapt their attributes to the `REST API` you are consuming. These models may have an schema, but this is not enough to ensure proper operation.
+
+To ensure the proper functioning of this gem, verify the `REST API` you are consuming, so that it contains the attributes you need for the operation of each module that you include in the model.
+
+For more information of the attributes you need for module, look at the [devise documentation](https://github.com/heartcombo/devise/blob/master/README.md).
+
+### Modules
+This gem adds one aditional module to devise:
+* Resource Authenticatable: This is a monkey patch, and it's needed if you want to use the [Database Authenticable module](https://www.rubydoc.info/github/heartcombo/devise/master/Devise/Models/DatabaseAuthenticatable) of `devise`.
+
+### Models
+The options to configure your models are the same of devise. The only consideration, is the `Resource Authenticatable` module. An example of a model:
+
+```ruby
+class User < ActiveResource::Base
+  devise :database_authenticatable, :rememberable,
+         :resource_authenticatable
+
+  self.site = 'https://some.api.com'
+end
+
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devise-activeresource'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install devise-activeresource
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,41 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Devise::Activeresource'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+# Rake::TestTask.new(:test) do |t|
+#   t.libs << 'test'
+#   t.pattern = 'test/**/*_test.rb'
+#   t.verbose = false
+# end
+
+Rake::TestTask.new(:test) do |test|
+  ENV['DEVISE_ORM'] ||= 'active_resource'
+  ENV['DEVISE_PATH'] ||= File.join(File.dirname(__FILE__), '../devise')
+  unless File.exist?(ENV['DEVISE_PATH'])
+    puts "Specify the path to devise (e.g. rake DEVISE_PATH=/path/to/devise). Not found at #{ENV['DEVISE_PATH']}"
+    exit
+  end
+  test.libs << 'lib' << 'test'
+  test.libs << "#{ENV['DEVISE_PATH']}/lib"
+  test.libs << "#{ENV['DEVISE_PATH']}/test"
+  test.test_files = FileList["#{ENV['DEVISE_PATH']}/test/**/*_test.rb"].exclude("#{ENV['DEVISE_PATH']}/test/**/serializable_test.rb")
+  test.verbose = false
+end
+
+task default: :test

data/lib/devise/activeresource.rb

@@ -0,0 +1,14 @@
+require 'devise'
+require 'devise/activeresource/base'
+require 'devise/activeresource/patch_methods'
+require 'devise/models/resource_authenticatable'
+
+module Devise
+  module Activeresource
+  end
+end
+
+if defined?(ActiveResource::Base)
+  require 'devise/activeresource/adapter'
+  Devise.add_module :resource_authenticatable, model: 'devise/models/resource_authenticatable'
+end

data/lib/devise/activeresource/adapter.rb

@@ -0,0 +1,106 @@
+module Devise
+  module Activeresource
+    # Adapter based on orm_adapter interface
+    # https://github.com/ianwhite/orm_adapter/blob/master/lib/orm_adapter/base.rb
+    class Adapter
+      attr_reader :klass
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      # Get a list of column/property/field names
+      def column_names
+        klass.attributes
+      end
+
+      # Get an instance by id of the model. Raises an error if a model is not found.
+      # This should comply with ActiveModel#to_key API, i.e.:
+      #
+      #   User.to_adapter.get!(@user.to_key) == @user
+      #
+      def get!(id)
+        klass.find(wrap_key(id))
+      end
+
+      # Get an instance by id of the model. Returns nil if a model is not found.
+      # This should comply with ActiveModel#to_key API, i.e.:
+      #
+      #   User.to_adapter.get(@user.to_key) == @user
+      #
+      def get(id)
+        klass.find(wrap_key(id))
+      rescue ActiveResource::ResourceNotFound
+        nil
+      end
+
+      # Find the first instance, optionally matching conditions
+      #
+      # You can call with just conditions, providing a hash
+      #
+      #   User.to_adapter.find_first :name => "Fred", :age => 23
+      #
+      #   User.to_adapter.find_first :conditions => {:name => "Fred", :age => 23}
+      #
+      def find_first(options = {})
+        conditions, limit, offset = extract_conditions!(options)
+        params = conditions.merge(limit_offset_hash(limit, offset))
+        klass.find(:first, params: params)
+      rescue ActiveResource::InvalidRequestError
+        nil
+      end
+
+      # Find all models, optionally matching conditions, and specifying order
+      # @see OrmAdapter::Base#find_first for how to specify order and conditions
+      def find_all(options = {})
+        conditions, limit, offset = extract_conditions!(options)
+        params = conditions.merge(limit_offset_hash(limit, offset))
+        klass.find(:all, params: params)
+      end
+
+      # Create a model using attributes
+      def create!(attributes = {})
+        klass.create(attributes)
+      end
+
+      # Destroy an instance by passing in the instance itself.
+      def destroy(object)
+        object.destroy
+      end
+
+      protected
+
+      def valid_object?(object)
+        object.class == klass
+      end
+
+      def wrap_key(key)
+        key.is_a?(Array) ? key.first : key
+      end
+
+      # given an options hash,
+      # with optional :conditions, :limit and :offset keys,
+      # returns conditions, limit and offset
+      def extract_conditions!(options = {})
+        _order     = options.delete(:order)
+        limit      = options.delete(:limit)
+        offset     = options.delete(:offset)
+        conditions = options.delete(:conditions) || options
+
+        [conditions, limit, offset]
+      end
+
+      def limit_offset_hash(limit, offset)
+        response = {}
+        response[:limit] = limit if limit && limit > 1
+        response[:offset] = offset if offset && offset > 1
+        response
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_resource) do
+  prepend ::Devise::Activeresource::PatchMethods
+  include ::Devise::Activeresource::Base
+end

data/lib/devise/activeresource/base.rb

@@ -0,0 +1,24 @@
+module Devise
+  module Activeresource
+    module Base
+      module ClassMethods
+        def to_adapter
+          @to_adapter ||= Devise::Activeresource::Adapter.new(self)
+        end
+
+        def increment_counter(counter_name, id)
+          element = find(id)
+          return false if element.nil?
+
+          value = element.send(counter_name)
+          element.send("#{counter_name}=", value + 1)
+          element.save
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/devise/activeresource/patch_methods.rb

@@ -0,0 +1,44 @@
+module Devise
+  module Activeresource
+    module PatchMethods
+      def initialize(*)
+        super
+        return unless self.class.schema
+
+        keys = self.class.schema.select { |_k, v| v == 'timestamp' }.keys
+        keys.each do |k|
+          value = send(k.to_sym)
+          next unless value.is_a?(String)
+
+          send("#{k}=".to_sym, Time.parse(value))
+        end
+      end
+
+      def invalid?
+        !valid?
+      end
+
+      def assign_attributes(attributes = {})
+        unless attributes.respond_to?(:to_hash)
+          raise ArgumentError, 'expected attributes to be able to convert'\
+            " to Hash, got #{attributes.inspect}"
+        end
+
+        attributes = attributes.to_hash
+        attributes.each do |key, value|
+          send("#{key}=".to_sym, value)
+        end
+      end
+
+      def [](attribute_name)
+        if attributes.include?(attribute_name)
+          attributes[attribute_name]
+        elsif respond_to?(attribute_name)
+          send(attribute_name)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/devise/activeresource/railtie.rb

@@ -0,0 +1,6 @@
+module Devise
+  module Activeresource
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/devise/activeresource/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module Activeresource
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/devise/models/resource_authenticatable.rb

@@ -0,0 +1,35 @@
+module Devise
+  module Models
+    module ResourceAuthenticatable
+      def update_with_password(params)
+        current_password = params.delete(:current_password)
+
+        if params[:password].blank?
+          params.delete(:password)
+          params.delete(:password_confirmation) if params[:password_confirmation].blank?
+        end
+
+        result = if valid_password?(current_password)
+                   update_attributes(params)
+                 else
+                   assign_attributes(params)
+                   valid?
+                   errors.add(:current_password, current_password.blank? ? :blank : :invalid)
+                   false
+                 end
+
+        clean_up_passwords
+        result
+      end
+
+      def update_without_password(params)
+        params.delete(:password)
+        params.delete(:password_confirmation)
+
+        result = update_attributes(params)
+        clean_up_passwords
+        result
+      end
+    end
+  end
+end

data/lib/devise/orm/active_resource.rb

@@ -0,0 +1,3 @@
+ActiveSupport.on_load(:active_resource) do
+  extend Devise::Models
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: devise-activeresource
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francisco Caiceo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+description: Plugin to use Active Resource in Devise
+email:
+- jfcaiceo55@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/devise/activeresource.rb
+- lib/devise/activeresource/adapter.rb
+- lib/devise/activeresource/base.rb
+- lib/devise/activeresource/patch_methods.rb
+- lib/devise/activeresource/railtie.rb
+- lib/devise/activeresource/version.rb
+- lib/devise/models/resource_authenticatable.rb
+- lib/devise/orm/active_resource.rb
+homepage: https://github.com/jfcaiceo/devise-activeresource
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Support for using Active Resource with Devise
+test_files: []