orm_adapter-fmrest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e19c15e6fcc08c53a32510c1a98c5dc66271f5d00143c5b5cc18ac30717f51f
+  data.tar.gz: c123ee2e3d1fca48ac771444f8b710fd5cb1f5cf8a6903af41578fb5cd60ebad
+SHA512:
+  metadata.gz: c5e22129ff41cbf904e0f74182917eaf471bc7cda2356768ccf2ec046a5d1107154eb5dc2921b944c95a2c5f01ee484e6da1ed247e677bc7aef30efcbe1e6b4c
+  data.tar.gz: 876ded434edf728ab5237547dcb5f148eeaea321bad7ed9fb62bc24fc5e0a164b5f8e06fed4395ed2b174650cef2d90683b053ed198a1e8f9edfbe87a0b8025b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at martin@itcmeier.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in orm_adapter-fmrest.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Martin Meier
+
+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,83 @@
+# OrmAdapter::Fmrest
+
+Adds Filemaker Rest to the orm_adaptor project.
+
+### ORM Adapter
+>Provides a single point of entry for popular ruby ORMs. Its target audience is gem authors who want to support more than one ORM.
+
+For more information see the [orm_adapter project](http://github.com/ianwhite/orm_adapter).
+
+### FmRest
+
+>A Ruby client for FileMaker's Data API with ActiveRecord-ish ORM features.
+
+For more information see the [fmrest-ruby gem](https://github.com/beezwax/fmrest-ruby).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'orm_adapter-fmrest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install orm_adapter-fmrest
+
+## Devise
+
+>Devise is a flexible authentication solution for Rails.
+
+For more information see the [Devise](https://github.com/plataformatec/devise).
+
+And now you can use Devise authentication based on Filemaker REST ORM.
+
+Add the following lines to Gemfile:
+
+```ruby
+gem 'fmrest-ruby'
+gem 'orm_adapter-fmrest'
+gem 'devise'
+```
+
+And then configure Devise using "--orm fmrest" parameter:
+
+    $ rails generate devise:install --orm fmrest
+    $ rails generate devise User --orm fmrest
+
+After that you can create User model:
+
+```ruby
+class User < FmRest::Layout
+  layout('your_user_layout')
+  extend Devise::Models
+  devise :database_authenticatable, :rememberable, :trackable
+
+
+end
+```
+
+## Known Limitations and Issues
+
+* There is no unit test. Fill free to add it.
+
+## Acknowledge
+
+Part of the code and logic (i.e. devise compatibility) is ripped from [orm_adapter-her](https://github.com/myxrome/orm_adapter-her).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/devise/orm/fmrest.rb

@@ -0,0 +1 @@
+# stub to enable devise to use orm_adapter-fmrest

data/lib/orm_adapter/fmrest/adapter.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+# ORM adaptor for Filmaker Rest
+require 'fmrest'
+
+module FmRest
+  module Spyke
+    class Base
+      extend OrmAdapter::ToAdapter
+
+      class OrmAdapter < ::OrmAdapter::Base
+
+        # Get a list of the attribute names (field names) in the Filemaker Layout.
+        # Map attribute names
+        def column_names
+          return [] unless klass.respond_to? :layout
+
+          field_meta = layout_meta klass.layout
+          fields = field_meta.map{|f| f['name']}
+          return fields unless klass.respond_to? :mapped_attributes
+
+          # map attribute names
+          fields + klass.mapped_attributes.keys - klass.mapped_attributes.values
+        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 FmRest::APIError::RecordMissingError
+          nil
+        end
+
+        # Find the first instance, optionally matching conditions, and specifying order
+        #
+        # You can call with just conditions, providing a hash
+        #
+        #   User.to_adapter.find_first :name => "Fred", :age => 23
+        #
+        # Or you can specify :order, and :conditions as keys
+        #
+        #   User.to_adapter.find_first :conditions => {:name => "Fred", :age => 23}
+        #   User.to_adapter.find_first :order => [:age, :desc]
+        #   User.to_adapter.find_first :order => :name, :conditions => {:age => 18}
+        #
+        # When specifying :order, it may be
+        # * a single arg e.g. <tt>:order => :name</tt>
+        # * a single pair with :asc, or :desc as last, e.g. <tt>:order => [:name, :desc]</tt>
+        # * an array of single args or pairs (with :asc or :desc as last), e.g. <tt>:order => [[:name, :asc], [:age, :desc]]</tt>
+        #
+        def find_first(options = {})
+          base_relation(options).first
+        end
+
+        # Find all models, optionally matching conditions, and specifying order
+        # @see OrmAdapter::Base#find_first for how to specify order and conditions
+        # @return Enumerable
+        def find_all(options = {})
+          base_relation(options)
+        end
+
+        # Create a model using attributes
+        def create!(attributes = {})
+          klass.new(attributes).save
+        end
+
+        # Destroy an instance by passing in the instance itself.
+        def destroy(object)
+          object.destroy if valid_object?(object)
+        end
+
+        private
+
+        # FmRest with converted query and sort parameters
+        # @return FmRest::Spyke::Relation
+        def base_relation(options)
+          conditions, order, limit, offset = extract_conditions!(options)
+
+          relation = klass.query(exact_conditions(conditions))
+          relation = relation.sort(*order_clause(order)) if order.any?
+          relation = relation.limit(limit) if limit
+          relation = relation.offset(offset) if offset
+
+          relation
+        end
+
+        def exact_conditions(conditions)
+          conditions.transform_values { |v| v.is_a?(String) ? "==#{v}" : v }
+        end
+
+        def order_clause(order)
+          order.map {|col, dir| (dir == :desc ? "#{col}__desc" : col).to_sym }
+        end
+
+        # given an order argument, returns an array of attributes (symbols) postfixed with __desc if order is reversed
+        def normalize_order(order)
+          if order.is_a? Array
+            order = [order] unless order.first.is_a?(Array)
+            order.map { |key, dir| (dir.to_s.downcase == 'desc' ? "key__desc" : key).to_sym }
+          else
+            [order.to_sym]
+          end
+        end
+
+        # request field meta data for layout of resource class
+        def layout_meta(layout)
+          FmRest::V1.build_connection(klass.try(:fmrest_config))
+                    .get("layouts/#{layout}")
+                    .body.dig('response', 'fieldMetaData')
+        end
+      end
+
+    end
+  end
+end

data/lib/orm_adapter/fmrest/version.rb

@@ -0,0 +1,5 @@
+module OrmAdapter
+  module Fmrest
+    VERSION = "0.1.0"
+  end
+end

data/lib/orm_adapter/fmrest.rb

@@ -0,0 +1,3 @@
+require 'orm_adapter'
+require 'orm_adapter/fmrest/version'
+require 'orm_adapter/fmrest/adapter' if defined? FmRest::Layout

data/orm_adapter-fmrest.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "orm_adapter/fmrest/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "orm_adapter-fmrest"
+  spec.version       = OrmAdapter::Fmrest::VERSION
+  spec.authors       = ["Martin Meier"]
+  spec.email         = ["martin@itcmeier.de"]
+
+  spec.summary       = %q{Adds Filemaker Rest to the orm_adaptor project.}
+  spec.homepage      = "https://github.com/mameier"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/mameier/orm_adapter-fmrest"
+    spec.metadata["changelog_uri"] = "https://github.com/mameier/orm_adapter-fmrest/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activemodel', '>= 3.0.0', '< 7.0.0'
+  spec.add_dependency 'activesupport', '>= 3.0.0', '< 7.0.0'
+  spec.add_dependency 'orm_adapter', '>= 0.5.0'
+  spec.add_dependency 'fmrest', '>= 0.18.0'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: orm_adapter-fmrest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Meier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: orm_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: fmrest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- martin@itcmeier.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/devise/orm/fmrest.rb
+- lib/orm_adapter/fmrest.rb
+- lib/orm_adapter/fmrest/adapter.rb
+- lib/orm_adapter/fmrest/version.rb
+- orm_adapter-fmrest.gemspec
+homepage: https://github.com/mameier
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mameier
+  source_code_uri: https://github.com/mameier/orm_adapter-fmrest
+  changelog_uri: https://github.com/mameier/orm_adapter-fmrest/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Adds Filemaker Rest to the orm_adaptor project.
+test_files: []