filemaker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da908ea60c24ec21422e5405e5c18e149825bb78
+  data.tar.gz: cf777449498d727f9c15ab765f5e610b292d0f8d
+SHA512:
+  metadata.gz: f6d6523f795649e9f2b09cc66ce21fff013586713a677b002734ffbc03eb3d5cdec949198764361d594c896851d1c7000f58e2adb28c76293091cd37b9acc029
+  data.tar.gz: 2b44e3649cfce1a9fa65ce5d7264f717ede0c86f63eafd695b9370deebd14f4870d2d5eb626860317e9cd5013e7f579cfa4bf64bd81125bd3ca7c38c1a49eda0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - .bundle/**
+    - filemaker.gemspec
+    - lib/filemaker/error.rb
+
+Documentation:
+  Enabled: false
+
+BracesAroundHashParameters:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+LineLength:
+  Max: 80

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+script: "bundle exec rake"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in filemaker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 mech
+
+MIT License
+
+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,116 @@
+# Filemaker
+
+[![Build Status](https://travis-ci.org/mech/filemaker-ruby.svg?branch=master)](https://travis-ci.org/mech/filemaker-ruby)
+
+A Ruby wrapper to FileMaker XML API.
+
+![UML - just kidding](diagram.png)
+
+## Installation
+
+Put this in your Gemfile and you are ready to go:
+
+```
+gem 'filemaker'
+```
+
+## Initializing the Server
+
+Ensure you have Web Publishing Engine (XML Publishing) enabled. Please turn on SSL also or credential will not be protected. Remember to also set the "Extended Privileges" to this keyword: `fmxml`.
+
+Configuration for initializing a server:
+
+* `host` - IP or hostname
+* `ssl` - `{ verify: false }` if you are using FileMaker's unsigned certificate. You can also pass a hash which will be forwarded to Faraday directly like `ssl: { client_cert: '', client_key: '', ca_file: '', ca_path: '/path/to/certs', cert_store: '' }`. See [Setting up SSL certificates](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates)
+* `account` - Please use `ENV` variable like `ENV['FILEMAKER_ACCOUNT']`
+* `password` - Please use `ENV` variable like `ENV['FILEMAKER_PASSWORD']`
+
+```ruby
+server = Filemaker::Server.new do |config|
+  config.host     = 'localhost'
+  config.account  = ENV['FILEMAKER_ACCOUNT']
+  config.password = ENV['FILEMAKER_PASSWORD']
+  config.ssl      = { verify: false }
+  config.log      = :curl
+end
+
+server.databases.all                   # Using -dbnames
+server.database['candidates'].layouts  # Using -layoutnames and -db=candidates
+
+api = server.db['candidates'].lay['profile']
+api = server.db['candidates']['profile']
+api = server.database['candidates'].layout['profile']
+```
+
+Once you are able to grab the `api`, you are golden and can make request to read/write to FileMaker API.
+
+## Using the API
+
+`Filemaker::Api::QueryCommands` is the main modules to use the API.
+
+* `api.find()` for `-find`
+* `api.findany()` for `-findany`
+* `api.findquery()` for `-findquery`
+* `api.new()` for `-new`
+* `api.edit()` for `-edit`
+* `api.delete()` for `-delete`
+* `api.dup()` for `-dup`
+* `api.view()` for `-view`
+
+Most API will be smart enough to reject invalid query parameters if passed in incorrectly.
+
+## Using Filemaker::Model
+
+If you want ActiveModel-like access with a decent query DSL like `where`, `find`, `all`, you can include `Filemaker::Model` to your model. Your Rails form will work as well as JSON serialization.
+
+```ruby
+class Job
+  include Filemaker::Model
+
+  server :default # Taken from filemaker.yml config file
+  database :jobs
+  layout :job
+
+  string :title, :requirements
+  datetime :created_at, :published_at
+
+  validates :title, presence: true
+
+  def as_json(options = {})
+    options[:except] ||= [:created_at]
+    super(options)
+  end
+end
+```
+
+```yml
+# filemaker.yml
+
+development:
+  default:
+    host: localhost
+    ssl: true
+```
+
+## Query DSL
+
+## Credits
+
+This project is heavily inspired by the following Filemaker Ruby effort and several other ORM gems.
+
+* [Rfm](https://github.com/lardawge/rfm)
+* [ginjo/rfm](https://github.com/ginjo/rfm)
+* [mongoid](https://github.com/mongoid/mongoid)
+* [elasticsearch-ruby](https://github.com/elasticsearch/elasticsearch-ruby)
+
+## Contributing
+
+We welcome pull request with specs.
+
+1. Fork it ( https://github.com/mech/filemaker-ruby/fork )
+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 a new Pull Request
+
+Do run `rubocop -D -f simple` before committing.

data/Rakefile

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

data/filemaker.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filemaker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'filemaker'
+  spec.version       = Filemaker::VERSION
+  spec.authors       = ['mech']
+  spec.email         = ['mech@me.com']
+  spec.summary       = 'A Ruby wrapper to FileMaker XML API.'
+  spec.description   = 'Provides ActiveModel-like object to read and write.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'typhoeus'
+  spec.add_runtime_dependency 'nokogiri'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry-byebug'
+end

data/lib/filemaker.rb

@@ -0,0 +1,13 @@
+require 'filemaker/version'
+require 'filemaker/core_ext/hash'
+require 'filemaker/server'
+require 'filemaker/api'
+require 'filemaker/database'
+require 'filemaker/store/database_store'
+require 'filemaker/store/layout_store'
+require 'filemaker/store/script_store'
+require 'filemaker/resultset'
+require 'filemaker/record'
+require 'filemaker/layout'
+require 'filemaker/script'
+require 'filemaker/error'

data/lib/filemaker/api.rb

@@ -0,0 +1,13 @@
+Dir[File.expand_path('../api/query_commands/**/*.rb', __FILE__)].each do |lib|
+  require lib
+end
+
+module Filemaker
+  module Api
+    module QueryCommands; end
+
+    def self.included(base)
+      base.send :include, Filemaker::Api::QueryCommands
+    end
+  end
+end

data/lib/filemaker/api/query_commands/delete.rb

@@ -0,0 +1,16 @@
+module Filemaker
+  module Api
+    module QueryCommands
+      # Delete record.
+      #
+      # -recid
+      # -script
+      # -script.param
+      #
+      def delete(id, options = {})
+        valid_options(options, :script)
+        perform_request('-delete', { '-recid' => id }, options)
+      end
+    end
+  end
+end

data/lib/filemaker/api/query_commands/dup.rb

@@ -0,0 +1,22 @@
+module Filemaker
+  module Api
+    module QueryCommands
+      # Duplicate record.
+      #
+      # -recid
+      # -script
+      # -script.param
+      # -relatedsets.filter
+      # -relatedsets.max
+      #
+      def dup(id, options = {})
+        valid_options(options,
+                      :script,
+                      :relatedsets_filter,
+                      :relatedsets_max)
+
+        perform_request('-dup', { '-recid' => id }, options)
+      end
+    end
+  end
+end

data/lib/filemaker/api/query_commands/edit.rb

@@ -0,0 +1,26 @@
+module Filemaker
+  module Api
+    module QueryCommands
+      # Edit record.
+      #
+      # -recid
+      # -modid
+      # -script
+      # -script.param
+      # -relatedsets.filter
+      # -relatedsets.max
+      # -delete.related
+      #
+      def edit(id, values, options = {})
+        valid_options(options,
+                      :modid,
+                      :script,
+                      :relatedsets_filter,
+                      :relatedsets_max,
+                      :delete_related)
+
+        perform_request('-edit', { '-recid' => id }.merge(values), options)
+      end
+    end
+  end
+end

data/lib/filemaker/api/query_commands/find.rb

@@ -0,0 +1,46 @@
+module Filemaker
+  module Api
+    module QueryCommands
+      # Find record(s).
+      #
+      # -max
+      # -skip
+      # -sortfield.[1-9]
+      # -sortorder.[1-9]
+      # -fieldname
+      # -fieldname.op
+      # -lop
+      # -recid
+      # -lay.response
+      # -script
+      # -script.param
+      # -script.prefind
+      # -script.prefind.param
+      # -script.presort
+      # -script.presort.param
+      # -relatedsets.filter
+      # -relatedsets.max
+      #
+      def find(id_or_hash, options = {})
+        valid_options(options,
+                      :max,
+                      :skip,
+                      :sortfield,
+                      :sortorder,
+                      :lop,
+                      :lay_response,
+                      :script,
+                      :script_prefind,
+                      :script_presort,
+                      :relatedsets_filter,
+                      :relatedsets_max)
+
+        if id_or_hash.is_a? Hash
+          perform_request('-find', id_or_hash, options)
+        else
+          perform_request('-find', { '-recid' => id_or_hash }, options)
+        end
+      end
+    end
+  end
+end

data/lib/filemaker/api/query_commands/findall.rb

@@ -0,0 +1,34 @@
+module Filemaker
+  module Api
+    module QueryCommands
+      # Find all records.
+      # Sorting may be slow for huge records.
+      #
+      # Acceptable params are:
+      # -max
+      # -skip
+      # -sortfield.[1-9]
+      # -sortorder.[1-9]
+      # -script
+      # -script.param
+      # -script.prefind
+      # -script.prefind.param
+      # -script.presort
+      # -script.presort.param
+      # -relatedsets.filter
+      #
+      def findall(options = {})
+        valid_options(options,
+                      :max,
+                      :skip,
+                      :sortfield,
+                      :sortorder,
+                      :script,
+                      :script_prefind,
+                      :relatedsets_filter)
+
+        perform_request('-findall', {}, options)
+      end
+    end
+  end
+end

data/lib/filemaker/api/query_commands/findany.rb

@@ -0,0 +1,26 @@
+module Filemaker
+  module Api
+    module QueryCommands
+      # Find a random record.
+      #
+      # If data cannot be coerced, it will crash!
+      # Acceptable params are:
+      # -script
+      # -script.param
+      # -script.prefind
+      # -script.prefind.param
+      # -relatedsets.filter
+      # -relatedsets.max
+      #
+      def findany(options = {})
+        valid_options(options,
+                      :script,
+                      :script_prefind,
+                      :relatedsets_filter,
+                      :relatedsets_max)
+
+        perform_request('-findany', {}, options)
+      end
+    end
+  end
+end