restio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bac9514467bdc135a3497e797e1c3e98e5eeebd
+  data.tar.gz: 63e7a072a1b276f14c099d3152a2e7d707da793e
+SHA512:
+  metadata.gz: f70e4502dbade720c4dc026ab7679539893f8f0a66026d843fa30654a1a5b9cec8f77bb4f9b71446954735b05b5eca53e1361d8c962e5b9d43358f9a5840fa9c
+  data.tar.gz: 344d48505519d371c1d6eaf0410fa786d33ebd503ae035976e1f4b87c5f626c1247abdb8b6c08177a323b572a7c41d744945e712ad4138df09e4fce0286444b5

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+lib/test/**/*

data/.ruby-gemset

@@ -0,0 +1 @@
+restio

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.1

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,39 @@
+# Restio
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/restio`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'restio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restio
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/restio/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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "restio"
+require "pry"
+Pry.start

data/bin/setup

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

data/lib/restio.rb

@@ -0,0 +1,11 @@
+require "restio/version"
+require "restio/config"
+require "restio/core_ext/object"
+
+module Restio
+  class << self
+    def config
+      @config ||= Restio::Config.new
+    end
+  end
+end

data/lib/restio/action.rb

@@ -0,0 +1,2 @@
+require "restio/action/collection"
+require "restio/action/resource"

data/lib/restio/action/collection.rb

@@ -0,0 +1,11 @@
+require "restio/connector"
+
+module Restio
+  module Action
+    module Collection
+      def rest
+        @rest ||= Restio::Connector::Collection.new self
+      end
+    end
+  end
+end

data/lib/restio/action/resource.rb

@@ -0,0 +1,9 @@
+module Restio
+  module Action
+    module Resource
+      def rest
+        @rest ||= Restio::Connector::Resource.new self
+      end
+    end
+  end
+end

data/lib/restio/config.rb

@@ -0,0 +1,14 @@
+require "restio/util/url"
+require "restio/util/header"
+
+module Restio
+  class Config
+    include Util::Header
+    def url
+      Util::Url.url
+    end
+    def url=url
+      Util::Url.url=url
+    end
+  end
+end

data/lib/restio/connector.rb

@@ -0,0 +1,2 @@
+require "restio/connector/collection"
+require "restio/connector/resource"

data/lib/restio/connector/collection.rb

@@ -0,0 +1,51 @@
+require "restio/connector/generic"
+
+module Restio
+  module Connector
+    class Collection < Generic
+      attr_accessor :identifier
+      attr_reader   :attributes
+      def initialize klass, params={}
+        @klass      = klass
+        @attributes = []
+        @type       = :collection
+      end
+      def add_attribute name
+        @attributes << name
+        @klass.send(:attr_accessor,name)
+      end
+      def build_instance response
+        return unless processable response
+        self.new_from_rest response.body
+      end
+      def build_instance_list response
+        return unless processable response
+        unwrap(response.body).collect do |resource_attributes|
+          @klass.new_from_rest resource_attributes
+        end
+      end
+      def first
+        list.first
+      end
+      def last
+        list.last
+      end
+      def list
+        build_instance_list Unirest.get url,
+          headers: headers
+      end
+      def read id
+        result = @klass.new
+        result.send("#{identifier}=",id)
+        result.rest.read
+        result
+      end
+      def delete id
+        result = @klass.new
+        result.send(result.rest.id,id)
+        result.rest.delete
+        result
+      end
+    end
+  end
+end

data/lib/restio/connector/generic.rb

@@ -0,0 +1,55 @@
+require "active_support/core_ext/string/inflections"
+require "restio/util/url"
+require "restio/util/header"
+require "unirest"
+require "restio/util/callback"
+
+module Restio
+  module Connector
+    class Generic
+      include Restio::Util::Url
+      include Restio::Util::Header
+      include Restio::Util::Callback
+      attr_accessor :wrapped, :use_backend_attributes
+      attr_reader   :type
+      def processable response
+        (200..299).include? response.code
+      end
+      def empty response
+        response.code == 204
+      end
+      def resource_name
+        @klass.name.underscore.split('/').last.singularize.to_s
+      end
+      def collection_name
+        @klass.name.underscore.split('/').last.pluralize.to_s
+      end
+      def name
+        case type
+        when :collection then collection_name
+        when :resource   then resource_name
+        end
+      end
+      def caster= caster
+        @caster_klass = "Restio::Util::Caster::#{caster.to_s.classify}"
+        @update_caster = true
+      end
+      def caster
+        return @caster if @caster and not @update_caster
+        @update_caster = false
+        @caster_klass ||= "Restio::Util::Caster::Default"
+        require @caster_klass.underscore
+        @caster = @caster_klass.constantize.new
+      end
+      def cast value
+        caster.cast value
+      end
+      def unwrap params={}
+        wrapped ? params[name] : params
+      end
+      def wrap params
+        wrapped ? { name => params } : params
+      end
+    end
+  end
+end

data/lib/restio/connector/resource.rb

@@ -0,0 +1,88 @@
+require "restio/connector/generic"
+require "restio/util/identifier"
+
+module Restio
+  module Connector
+    class Resource < Generic
+      include Restio::Util::Identifier
+      def initialize instance, params={}
+        @instance = instance
+        @type     = :resource
+        @klass    = instance.class
+      end
+      def identifier
+        @instance.send @klass.rest.identifier
+      end
+      def attributes
+        @klass.rest.attributes
+      end
+      def wrapped
+        @klass.rest.wrapped
+      end
+      def value_of name
+        @instance.instance_variable_get "@#{name}"
+      end
+      def register_attribute name
+        return false unless @klass.rest.use_backend_attributes
+        @klass.rest.add_attribute name.to_sym
+        true
+      end
+      def set_value name, value
+        value = cast(value)
+        register_attribute(name) ?
+        @instance.send("#{name}=", value) :
+        @instance.instance_variable_set("@#{name}", value)
+      end
+      def parameters
+        result = attributes.collect do |name|
+          [name,value_of(name)]
+        end.to_h
+        wrap result
+      end
+      def update_instance response
+        return unless processable response
+        unwrap(response.body).each do |name,value|
+          set_value name, value
+        end unless empty response
+        @instance
+      end
+      def delete_instance response
+        return true if processable response
+        false
+      end
+      def create
+        run_callbacks :before, __method__
+        update_instance Unirest.post @klass.rest.url,
+          headers: headers,
+          parameters: parameters
+        run_callbacks :after, __method__
+      end
+      def read
+        run_callbacks :before, __method__
+        update_instance Unirest.get url,
+          headers: headers
+        run_callbacks :after, __method__
+      end
+      def update
+        run_callbacks :before, __method__
+        update_instance Unirest.put url,
+          headers: headers,
+          parameters: parameters
+        run_callbacks :after, __method__
+      end
+      def delete
+        run_callbacks :before, __method__
+        delete_instance Unirest.delete url,
+          headers: headers
+        run_callbacks :after, __method__
+      end
+      def with_attributes &block
+        run_callbacks :before, __method__
+        @klass.rest.attributes.each do |name|
+          yield(name,@instance.send(name))
+        end
+        run_callbacks :after, __method__
+      end
+    end
+  end
+end

data/lib/restio/core_ext/object.rb

@@ -0,0 +1,18 @@
+require "restio/action"
+require "restio/extension"
+
+class Object
+  def self.restful id: :id, wrapped:false, use_backend_attributes: false
+    extend  Restio::Extension::Identifier
+    extend  Restio::Extension::Attribute
+    extend  Restio::Extension::Builder
+    extend  Restio::Extension::Caster
+    extend  Restio::Extension::Callback
+    extend  Restio::Action::Collection
+    include Restio::Action::Resource
+    self.send(:attr_accessor,id)
+    rest.identifier             = id
+    rest.wrapped                = wrapped
+    rest.use_backend_attributes = use_backend_attributes
+  end
+end  

data/lib/restio/extension.rb

@@ -0,0 +1,5 @@
+require "restio/extension/identifier"
+require "restio/extension/attribute"
+require "restio/extension/builder"
+require "restio/extension/caster"
+require "restio/extension/callback"

data/lib/restio/extension/attribute.rb

@@ -0,0 +1,12 @@
+module Restio
+  module Extension
+    module Attribute
+      def rest_attributes *attributes
+        attributes.each do |name|
+          rest.add_attribute name
+        end
+      end
+      alias_method :rest_attribute, :rest_attributes
+    end
+  end
+end

data/lib/restio/extension/builder.rb

@@ -0,0 +1,13 @@
+module Restio
+  module Extension
+    module Builder
+      def new_from_rest params={}
+        result = self.new
+        result.rest.unwrap(params).each do |name,value|
+          result.rest.set_value name, value
+        end
+        result
+      end
+    end
+  end
+end

data/lib/restio/extension/callback.rb

@@ -0,0 +1,9 @@
+module Restio
+  module Extension
+    module Callback
+      def rest_callback stage, action, method
+        rest.register_callback stage, action, method
+      end     
+    end
+  end
+end

data/lib/restio/extension/caster.rb

@@ -0,0 +1,9 @@
+module Restio
+  module Extension
+    module Caster
+      def rest_caster caster=:default
+        rest.caster = caster
+      end     
+    end
+  end
+end

data/lib/restio/extension/identifier.rb

@@ -0,0 +1,10 @@
+module Restio
+  module Extension
+    module Identifier
+      def rest_identifier id
+        rest.add_attribute id
+        rest.identifier =  id
+      end
+    end
+  end
+end

data/lib/restio/util/callback.rb

@@ -0,0 +1,30 @@
+module Restio
+  module Util
+    module Callback
+      attr_reader :callbacks
+      def register_callback stage, action, method_or_block
+        @callbacks ||= {}
+        @callbacks[action] ||= {}
+        @callbacks[action][stage] ||= []
+        @callbacks[action][stage] << method_or_block
+      end
+      def run_callbacks stage, action
+        get_callbacks(action,stage).each do |cb|
+          if cb.is_a? Symbol
+            case @type
+            when :collection then @klass.send(cb)
+            when :resource   then @instance.send(cb)
+            end
+          end
+        end
+      end
+      private
+      def get_callbacks action, stage
+        cbs  = []
+        (cbs += @callbacks[action][stage]) rescue nil
+        (cbs += @klass.rest.callbacks[action][stage]) rescue nil
+        cbs
+      end
+    end
+  end
+end

data/lib/restio/util/caster.rb

@@ -0,0 +1,11 @@
+require "restio/util/caster/default"
+
+module Restio
+  module Util
+    module Caster
+      def rest_caster caster=nil
+        rest.caster = ( caster || :default)
+      end
+    end
+  end
+end

data/lib/restio/util/caster/default.rb

@@ -0,0 +1,24 @@
+require "restio/util/caster/generic"
+require "uuidtools"
+
+module Restio
+  module Util
+    module Caster
+      class Default < Generic
+        RE_FLOAT = /^[0-9]+\.[0-9]+$/
+        RE_INT   = /^[0-9]+$/
+        RE_UUID  = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
+        def map value
+          return value if value.nil?
+          return value unless value.is_a? String
+          return true if value == "true"
+          return false if value == "false"
+          return value.to_i if value.match(RE_INT)
+          return value.to_f if value.match(RE_FLOAT)
+          return UUIDTools::UUID.parse(value) if value.match(RE_UUID)
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/restio/util/caster/generic.rb

@@ -0,0 +1,14 @@
+module Restio
+  module Util
+    module Caster
+      class Generic
+        def map value
+          raise "Define #{self.class}#map(value)"
+        end
+        def cast value
+          map(value) || value
+        end
+      end
+    end
+  end
+end

data/lib/restio/util/header.rb

@@ -0,0 +1,15 @@
+module Restio
+  module Util
+    module Header
+      def add_header name, value
+        @headers ||= {}
+        @headers[name] = value
+      end
+      def headers
+        @headers ||= {}
+        return @headers if self.class.name == 'Restio::Config'
+        @headers.merge(Restio.config.headers)
+      end
+    end
+  end
+end

data/lib/restio/util/identifier.rb

@@ -0,0 +1,7 @@
+module Restio
+  module Util
+    module Identifier
+      attr_accessor :rest_identifier
+    end
+  end
+end

data/lib/restio/util/url.rb

@@ -0,0 +1,26 @@
+require "pathname"
+require "active_support/core_ext/string/inflections"
+
+module Restio
+  module Util
+    module Url
+      class << self
+        attr_writer :url
+        def url
+          Pathname.new (@url || 'http://example.com')
+        end
+      end
+      attr_accessor :base_url
+      def url
+        case type
+        when :collection
+          base_url ||= Restio.config.url
+          base_url   = Pathname.new(base_url) if base_url
+          base_url.join(@klass.rest.name).to_s
+        when :resource
+          Pathname.new(@klass.rest.url).join(identifier.to_s).to_s
+        end
+      end
+    end
+  end
+end

data/lib/restio/version.rb

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

data/restio.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "restio"
+  spec.version       = Restio::VERSION
+  spec.authors       = ["Mathias Kaufmann"]
+  spec.email         = ["me@stei.gr"]
+
+  spec.summary       = %q{Adding restful interface to Ruby-Objects.}
+  spec.description   = %q{Adding restful interface to Ruby-Objects. Each Object is extended by a .rest-Member which handles communication to any RESTful Web API.}
+  spec.homepage      = "https://restio.stei.gr/"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "unirest", "~> 1.1"
+  spec.add_dependency "activesupport", ">= 2.2.1"
+  spec.add_dependency "uuidtools",  "~> 2.1"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: restio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mathias Kaufmann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: pry
+  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: Adding restful interface to Ruby-Objects. Each Object is extended by
+  a .rest-Member which handles communication to any RESTful Web API.
+email:
+- me@stei.gr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/restio.rb
+- lib/restio/action.rb
+- lib/restio/action/collection.rb
+- lib/restio/action/resource.rb
+- lib/restio/config.rb
+- lib/restio/connector.rb
+- lib/restio/connector/collection.rb
+- lib/restio/connector/generic.rb
+- lib/restio/connector/resource.rb
+- lib/restio/core_ext/object.rb
+- lib/restio/extension.rb
+- lib/restio/extension/attribute.rb
+- lib/restio/extension/builder.rb
+- lib/restio/extension/callback.rb
+- lib/restio/extension/caster.rb
+- lib/restio/extension/identifier.rb
+- lib/restio/util/callback.rb
+- lib/restio/util/caster.rb
+- lib/restio/util/caster/default.rb
+- lib/restio/util/caster/generic.rb
+- lib/restio/util/header.rb
+- lib/restio/util/identifier.rb
+- lib/restio/util/url.rb
+- lib/restio/version.rb
+- restio.gemspec
+homepage: https://restio.stei.gr/
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Adding restful interface to Ruby-Objects.
+test_files: []