json_ffi_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d891b33e4b3cfbef290c60aa57d679259f73b0b
+  data.tar.gz: e7641bf8f69795b8c1aaccf460e36d25124976f5
+SHA512:
+  metadata.gz: 75cee4998c85f2705c1bb5c69d4597ca025c6ceacea8c1e0ff642d1306f9065efcccc3aa50ecfe94f4c62e7d6c08cc3fde24f2ef1611eba179d28f2571c67a7b
+  data.tar.gz: 92841d410fcd6802aed11ac3333138f5e881b8753a6fc51cd1c3f8a4fb130c195ee0afb845eedf1388c91a5c7022eea5e6a5aae737dac67d03721b1b0175857a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.swo

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6
+os:
+  - linux
+  - osx

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 nubis
+
+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,55 @@
+# JsonFfiClient
+
+[![Build
+Status](https://travis-ci.org/bitex-la/json-ffi-client-ruby.svg?branch=master)](https://travis-ci.org/bitex-la/json-ffi-client-ruby)
+
+JSON-FFI is an implementation of the [jsonapi.org](http://jsonapi.org)
+protocol where instead of hitting a server your client communicates
+with a local shared library.
+
+It's a way to bridge the gap between native libraries and dynamic languages.
+
+This gem provides a Connection class for the "json_api_client" gem.
+(it does not explicitly depend on "json_api_client though)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_ffi_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_ffi_client
+
+## Usage
+
+Assuming:
+
+- You have a library called "funky" acting as the JSON FFI server for a 'person' resource.
+- You have versions of your libraries for Linux, OS X and Windows called "libfunky.so", "libfunky.dylib" and "libfunky.dll".
+- All three live in the same directory as the file defining your JsonApiclient::Resource subclass.
+
+```ruby
+    class Person < JsonApiClient::Resource
+      self.connection_class =
+        JsonFfiClient::Connection.configured_for(:funky, __dir__)
+    end
+```
+
+## Development
+
+This gem could be the reference implementation for JSON FFI clients.
+
+The JSON FFI protocol is in early stages of development.
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_ffi_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_ffi_client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_ffi_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_ffi_client"
+  spec.version       = JsonFfiClient::VERSION
+  spec.authors       = ["nubis"]
+  spec.email         = ["nb@bitex.la"]
+
+  spec.summary       = "Build ruby JSON-FFI clients using ffi & json_api_client"
+  spec.homepage      = "https://github.com/bitex-la/json_ffi_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "ffi", "~> 1.9"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "json_api_client", "~> 1.5"
+  spec.add_development_dependency "byebug", "~> 9.0"
+end

data/lib/json_ffi_client.rb

@@ -0,0 +1,58 @@
+require "json_ffi_client/version"
+require "json"
+require "ffi"
+
+module JsonFfiClient
+  class Response < FFI::AutoPointer
+    def self.release(ptr)
+      Connection.free(ptr)
+    end
+
+    def body
+      @body ||= JSON.parse(self.read_string).delete_if{|k,v| v.nil?}
+    end
+    
+    def env
+      {}
+    end
+  end
+
+  class Connection
+    extend FFI::Library
+    def initialize(*args); end
+
+    def self.configured_for(library_name, base_path)
+      @@library_name = library_name
+
+      lib_ext = if(FFI::Platform.mac?)
+        "dylib"
+      elsif(FFI::Platform.windows?)
+        "dll"
+      else
+        "so"
+      end
+
+      begin 
+        ffi_lib File.join(base_path, "lib#{library_name}.#{lib_ext}")
+      rescue LoadError => e
+        raise Error
+          .new("#{e.message}. Maybe '#{RUBY_PLATFORM}' is not supported.")
+      end
+
+      attach_function :free, "#{library_name}_free".to_sym, [Response], :void
+      self
+    end
+    
+    def self.method_missing(message, *args, &blk)
+      attach_function message, message, [:string], Response
+      send(message, *args)
+    end
+    
+    def run(method, path, params = {}, headers = {})
+      raise JsonFfiError.new("Connection not configured") unless @@library_name
+      self.class.send([@@library_name, method, path].join("_"), params.to_json)
+    end
+  end
+
+  class Error < StandardError; end
+end

data/lib/json_ffi_client/version.rb

@@ -0,0 +1,3 @@
+module JsonFfiClient
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: json_ffi_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nubis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: json_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: 
+email:
+- nb@bitex.la
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_ffi_client.gemspec
+- lib/json_ffi_client.rb
+- lib/json_ffi_client/version.rb
+homepage: https://github.com/bitex-la/json_ffi_client
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Build ruby JSON-FFI clients using ffi & json_api_client
+test_files: []