fmrest 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61e4602ba4797de70a866ea14197056bd0d09ca0bab4d09e44ddade7719395ac
-  data.tar.gz: 77982322ac28bef17e648888dc67753a56fb02c3b31e616d7d4129c6031ba676
+  metadata.gz: 79fff3279b30b2bf4ba228646218abc622366aa97f48b1a60eee06d1cea249c8
+  data.tar.gz: a7b9c8fb36117733176ec355e6e80ef6981ee0e990f1b42fb5721a0baca46ff4
 SHA512:
-  metadata.gz: c872d1d1b37710720d0cd5398f985c1abc6d59105fe117905518d86f2617f82e539e743b8d57693bde34558381a500d32f1d942f240705db21d5415ca2c86f14
-  data.tar.gz: e71b4ca034162ed34b847b66d7ae0063f3fa654be1a73ddf12c9f995ca62956a186737ca15ba06939d5982a3b62bab30c2ad7d125498b07024276a7b0518d00c
+  metadata.gz: 1e38235d837ddd968164256c78f64bab77ed9464c2f33ee69d4e4f5920d093eeea082b0547f544edc409c5416d470bdd13998b42cb1ac2c501a2f485709ff5a5
+  data.tar.gz: 813305093670cbe0a684f0d63d079e9a5d799373521099d6229cf22a4cf34d3107167ac5a6b8750bf6abd410bc24f89fd84ea7aacf040e696c8196e57d8f21b4

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 0.5.1
+
+* Alias `:username` option as `:account_name` for ginjo-rfm gem
+  cross-compatibility
+
 ### 0.5.0
 
 * Much improved script execution support

data/README.md

@@ -3,19 +3,17 @@
 <a href="https://rubygems.org/gems/fmrest"><img src="https://badge.fury.io/rb/fmrest.svg?style=flat" alt="Gem Version"></a>
 
 A Ruby client for
-[FileMaker 17's Data API](https://fmhelp.filemaker.com/docs/17/en/dataapi/)
+[FileMaker 18's Data API](https://fmhelp.filemaker.com/docs/18/en/dataapi/)
 using
 [Faraday](https://github.com/lostisland/faraday) and with optional
 [Spyke](https://github.com/balvig/spyke) support (ActiveRecord-ish models).
 
-FileMaker 16's Data API is not supported (but you shouldn't be using it
-anyway).
-
 If you're looking for a Ruby client for the legacy XML/Custom Web Publishing
 API try the fabulous [ginjo-rfm gem](https://github.com/ginjo/rfm) instead.
 
-fmrest-ruby does not currently implement the full spec of FileMaker 17's Data
-API.
+fmrest-ruby only partially implements FileMaker 18's Data API.
+See the [implementation completeness table](#api-implementation-completeness-table)
+to see if a feature you need is natively supported by the gem.
 
 ## Installation
 
@@ -24,11 +22,11 @@ Add this line to your Gemfile:
 ```ruby
 gem 'fmrest'
 
-# Optional (for ORM features)
+# Optional but recommended (for ORM features)
 gem 'spyke'
 ```
 
-## Basic usage
+## Basic usage (without ORM)
 
 To get a Faraday connection that can handle FM's Data API auth workflow:
 
@@ -79,9 +77,12 @@ FmRest::V1.build_connection(
 )
 ```
 
-You can use the `:log` option for basic request logging, see the section on
+You can also pass a `:log` option for basic request logging, see the section on
 [Logging](#Logging) below.
 
+`:username` is also aliased as `:account_name` to provide cross-compatibility
+with the ginjo-rfm gem.
+
 ### Default connection settings
 
 If you're only connecting to a single FM database you can configure it globally
@@ -234,13 +235,15 @@ class Honeybee < FmRest::Spyke::Base
 end
 ```
 
-In this case you can pass the `fmrest_config` hash as an argument to `Base()`:
+In this case you can pass the [`fmrest_config`](#modelfmrest_config) hash as an
+argument to `Base()`:
 
 ```ruby
 class Honeybee < FmRest::Spyke::Base(host: "...", database: "...", username: "...", password: "...")
 end
 
-Honeybee.fmrest_config # => { host: "...", database: "...", username: "...", password: "..." }
+Honeybee.fmrest_config
+# => { host: "...", database: "...", username: "...", password: "..." }
 ```
 
 All of Spyke's basic ORM operations work:
@@ -839,6 +842,37 @@ class LoggyBee < FmRest::Spyke::Base
 end
 ```
 
+## API implementation completeness table
+
+FM Data API reference: https://fmhelp.filemaker.com/docs/18/en/dataapi/
+
+| FM 18 Data API feature              | Supported by basic connection | Supported by FmRest::Spyke::Base |
+|-------------------------------------|-------------------------------|----------------------------------|
+| Log in using HTTP Basic Auth        | Yes                           | Yes                              |
+| Log in using OAuth                  | No                            | No                               |
+| Log in to an external data source   | No                            | No                               |
+| Log in using a FileMaker ID account | No                            | No                               |
+| Log out                             | Manual*                       | No                               |
+| Get product information             | Manual*                       | No                               |
+| Get database names                  | Manual*                       | No                               |
+| Get script names                    | Manual*                       | No                               |
+| Get layout names                    | Manual*                       | No                               |
+| Get layout metadata                 | Manual*                       | No                               |
+| Create a record                     | Manual*                       | Yes                              |
+| Edit a record                       | Manual*                       | Yes                              |
+| Duplicate a record                  | Manual*                       | No                               |
+| Delete a record                     | Manual*                       | Yes                              |
+| Get a single record                 | Manual*                       | Yes                              |
+| Get a range of records              | Manual*                       | Yes                              |
+| Get container data                  | Manual*                       | Yes                              |
+| Upload container data               | Manual*                       | Yes                              |
+| Perform a find request              | Manual*                       | Yes                              |
+| Set global field values             | Manual*                       | No                               |
+| Run a script                        | Manual*                       | Yes                              |
+| Run a script with another request   | Manual*                       | Yes                              |
+
+\* You can manually supply the URL and JSON to a `FmRest` connection.
+
 ## TODO
 
 - [ ] Support for FM18 features
@@ -853,7 +887,7 @@ end
 - [x] Specs
 - [x] Support for portal data
 
-## Development
+## Gem development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
 `rake spec` to run the tests. You can also run `bin/console` for an interactive

data/fmrest.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "mock_redis"
   spec.add_development_dependency "moneta"
+  spec.add_development_dependency "yard"
 end

data/lib/fmrest/v1/connection.rb

@@ -14,6 +14,10 @@ module FmRest
       # error handling. A block can be optionally given for additional
       # middleware configuration
       #
+      # @option options [String] :username The username for DAPI authentication
+      # @option options [String] :account_name Alias of :username for
+      #   compatibility with Rfm gem
+      # @option options [String] :password The password for DAPI authentication
       # @option (see #base_connection)
       # @return (see #base_connection)
       def build_connection(options = FmRest.default_connection_settings, &block)
@@ -49,8 +53,6 @@ module FmRest
       #
       # @option options [String] :host The hostname for the FM server
       # @option options [String] :database The FM database name
-      # @option options [String] :username The username for DAPI authentication
-      # @option options [String] :password The password for DAPI authentication
       # @option options [String] :ssl SSL options to forward to the Faraday
       #   connection
       # @option options [String] :proxy Proxy options to forward to the Faraday

data/lib/fmrest/v1/token_session.rb

@@ -96,7 +96,9 @@ module FmRest
 
       def auth_connection
         @auth_connection ||= V1.base_connection(@options) do |conn|
-          conn.basic_auth @options.fetch(:username), @options.fetch(:password)
+          username = @options.fetch(:account_name) { @options.fetch(:username) }
+
+          conn.basic_auth username, @options.fetch(:password)
 
           if @options[:log]
             conn.response :logger, nil, bodies: true, headers: true

data/lib/fmrest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FmRest
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -190,6 +190,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: FileMaker Data API client using Faraday, with optional ActiveRecord-like
   ORM based on Spyke
 email: