acfs 0.2.0 → 0.3.0

data/.gitignore

@@ -17,5 +17,4 @@ test/version_tmp
 tmp
 .idea
 *.iml
-.rakeTasks
 .rvmrc

data/.travis.yml

@@ -2,9 +2,7 @@ language: ruby
 rvm:
   - 2.0.0
   - 1.9.3
-  - jruby
 
 gemfile:
-  - gemfiles/Gemfile.rails-3-1
   - gemfiles/Gemfile.rails-3-2
-  - gemfiles/Gemfile.rails-head
+  - gemfiles/Gemfile.rails-4-0

data/README.md

@@ -1,4 +1,4 @@
-# Acfs - *API Client for Services*
+# Acfs - *API client for services*
 
 [![Gem Version](https://badge.fury.io/rb/acfs.png)](http://badge.fury.io/rb/acfs) [![Build Status](https://travis-ci.org/jgraichen/acfs.png?branch=master)](https://travis-ci.org/jgraichen/acfs) [![Coverage Status](https://coveralls.io/repos/jgraichen/acfs/badge.png?branch=master)](https://coveralls.io/r/jgraichen/acfs) [![Code Climate](https://codeclimate.com/github/jgraichen/acfs.png)](https://codeclimate.com/github/jgraichen/acfs) [![Dependency Status](https://gemnasium.com/jgraichen/acfs.png)](https://gemnasium.com/jgraichen/acfs)
 
@@ -10,7 +10,10 @@ TODO: Write a gem description
 
 Add this line to your application's Gemfile:
 
-    gem 'acfs'
+    gem 'acfs', '0.3.0'
+
+**Note:** Acfs is under development. API may change anytime. No semantic versioning until version `1.0`. Version `1.0`
+does not mean complete feature set but stable basic code base.
 
 And then execute:
 
@@ -22,13 +25,11 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-### Acfs::Attributes
+### Attributes
 
 ```ruby
 class MyModel
-  include Acfs::Attributes
+  include Acfs::Model
 
   attribute :name, :string
   attribute :age, :integer, default: 15
@@ -41,12 +42,43 @@ mo.name # => "Johnny"
 mo.age = '13'
 mo.age # => 13
 mo.attributes # => { "name" => "Johnny", "age" => 13 }
+```
+
+### Service, Model & Collection
+
+```ruby
+class MyService < Acfs::Service
+  self.base_url = 'http://acc.srv'
+end
+
+class User
+  include Acfs::Model
+  service MyService
+
+  attribute :id, :integer
+end
 
+@user = User.find 14
+
+@user.loaded? #=> false
+
+Acfs.run # This will run all queued request as parallel as possible.
+         # For @user the following URL will be requested:
+         # `http://acc.srv/users/14`
+
+@model.name # => "..."
+
+@users = User.all
+@users.loaded? #=> false
+
+Acfs.run # Will request `http://acc.srv/users`
+
+@users #=> [<User>, ...]
 ```
 
 ## TODO
 
-* Library Code
+* Develop Library
 * Documentation
 
 ## Contributing
@@ -58,3 +90,9 @@ mo.attributes # => { "name" => "Johnny", "age" => 13 }
 5. Commit your changes (`git commit -am 'Add some feature'`)
 6. Push to the branch (`git push origin my-new-feature`)
 7. Create new Pull Request
+
+## License
+
+MIT License
+
+Copyright (c) 2013 Jan Graichen. MIT license, see LICENSE for more details.

data/acfs.gemspec

@@ -20,8 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'activesupport'
   spec.add_runtime_dependency 'activemodel'
+  spec.add_runtime_dependency 'multi_json'
+  spec.add_runtime_dependency 'typhoeus'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'webmock', '~> 1.7'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'guard-rspec'

data/gemfiles/{Gemfile.rails-3-1 → Gemfile.rails-4-0}

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in acfs.gemspec
 gemspec path: '../'
 
-gem 'activesupport', '~> 3.1.0'
-gem 'activemodel', '~> 3.1.0'
+gem 'activesupport', '~> 4.0.0.beta1'
+gem 'activemodel', '~> 4.0.0.beta1'

data/lib/acfs.rb

@@ -1,14 +1,58 @@
 require 'active_support'
+require 'active_support/core_ext'
 require 'acfs/version'
 
 module Acfs
   extend ActiveSupport::Autoload
 
-  autoload :Client
-  autoload :Base
-
+  autoload :Collection
   autoload :Model
-  autoload :Attributes
-  autoload :Initialization
+  autoload :Request
+  autoload :Response
+  autoload :Service
+
+  module Middleware
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :Print
+    autoload :JsonDecoder
+  end
+
+  module Adapter
+    extend ActiveSupport::Autoload
+
+    autoload :Typhoeus
+  end
+
+  class << self
+
+    # Run all queued
+    def run
+      adapter.run
+    end
+
+    def queue(req, &block)
+      request = middleware.call Request.new(req)
+      request.on_complete &block if block_given?
+      adapter.queue request
+    end
+
+    def adapter
+      @adapter ||= Adapter::Typhoeus.new
+    end
+
+    def middleware
+      @middleware ||= lambda { |request| request }
+    end
+
+    def use(klass, options = {})
+      @middlewares ||= []
+
+      return false if @middlewares.include? klass
 
+      @middlewares << klass
+      @middleware = klass.new(middleware, options)
+    end
+  end
 end

data/lib/acfs/adapter/typhoeus.rb

@@ -0,0 +1,42 @@
+require 'typhoeus'
+
+module Acfs
+  module Adapter
+
+    # Adapter for Typhoeus.
+    #
+    class Typhoeus
+
+      # Run all queued requests.
+      #
+      def run
+        hydra.run
+      end
+
+      # Add a new request or URL to the queue.
+      #
+      def queue(req)
+        hydra.queue convert_request(req)
+      end
+
+    protected
+      def hydra
+        @hydra ||= ::Typhoeus::Hydra.new
+      end
+
+      def convert_request(req)
+        request = ::Typhoeus::Request.new req.url, params: req.params, headers: req.headers, body: req.body
+
+        request.on_complete do |response|
+          req.complete! convert_response(req, response)
+        end
+
+        request
+      end
+
+      def convert_response(request, response)
+        Acfs::Response.new(request, response.code, response.headers, response.body)
+      end
+    end
+  end
+end

data/lib/acfs/collection.rb

@@ -0,0 +1,22 @@
+require 'delegate'
+
+require 'acfs/model/loadable'
+
+module Acfs
+
+  class Collection < ::Delegator
+    include Model::Loadable
+
+    def initialize
+      super([])
+    end
+
+    def __getobj__
+      @models
+    end
+
+    def __setobj__(obj)
+      @models = obj
+    end
+  end
+end

data/lib/acfs/middleware/base.rb

@@ -0,0 +1,21 @@
+module Acfs
+  module Middleware
+
+    # A base middleware that does not modify request or response.
+    # Can be used as super class for custom middleware implementations.
+    #
+    class Base
+      attr_reader :app, :options
+
+      def initialize(app, options = {})
+        @app     = app
+        @options = options
+      end
+
+      def call(request)
+        request.on_complete { |res| response(res) } if respond_to? :response
+        app.call(request)
+      end
+    end
+  end
+end

data/lib/acfs/middleware/json_decoder.rb

@@ -0,0 +1,15 @@
+require 'multi_json'
+
+module Acfs
+  module Middleware
+
+    # A middleware to automatically decode JSON responses.
+    #
+    class JsonDecoder < Base
+
+      def response(response)
+        response.data = ::MultiJson.load(response.body) if response.json?
+      end
+    end
+  end
+end

data/lib/acfs/middleware/print.rb

@@ -0,0 +1,23 @@
+module Acfs
+  module Middleware
+
+    # Print resquests and response on terminal
+    #
+    class Print < Base
+
+      def call(req)
+        puts '-' * 80
+        puts req.inspect
+        puts '-' * 80
+
+        super
+      end
+
+      def response(res)
+        puts '-' * 80
+        puts res.inspect
+        puts '-' * 80
+      end
+    end
+  end
+end

data/lib/acfs/model.rb

@@ -1,22 +1,35 @@
 require 'active_model'
 
+require 'acfs/model/attributes'
+require 'acfs/model/loadable'
+require 'acfs/model/locatable'
+require 'acfs/model/query_methods'
+require 'acfs/model/relations'
+require 'acfs/model/service'
+
 module Acfs
   module Model
-    def self.included(base)
-      base.class_eval do
-        if ActiveModel::VERSION::MAJOR >= 4
-          include ActiveModel::Model
-        else
-          extend  ActiveModel::Naming
-          extend  ActiveModel::Translation
-          include ActiveModel::Conversion
-          include ActiveModel::Validations
+    extend ActiveSupport::Concern
 
-          include Acfs::Initialization
-        end
+    included do
+      if ActiveModel::VERSION::MAJOR >= 4
+        include ActiveModel::Model
+      else
+        extend  ActiveModel::Naming
+        extend  ActiveModel::Translation
+        include ActiveModel::Conversion
+        include ActiveModel::Validations
 
-        include Acfs::Attributes
+        require 'acfs/model/initialization'
+        include Model::Initialization
       end
+
+      include Model::Attributes
+      include Model::Loadable
+      include Model::Locatable
+      include Model::QueryMethods
+      include Model::Relations
+      include Model::Service
     end
   end
 end

data/lib/acfs/{attributes.rb → model/attributes.rb}

@@ -1,12 +1,11 @@
-module Acfs
+module Acfs::Model
 
-  # == Acfs Attribute
+  # == Acfs Attributes
   #
   # Allows to specify attributes of a class with default values and type safety.
   #
   #   class User
-  #     include Acfs::Attributes
-  #
+  #     include Acfs::Model
   #     attribute :name, :string, default: 'Anon'
   #     attribute :age, :integer
   #     attribute :special, My::Special::Type
@@ -16,30 +15,31 @@ module Acfs
   # type casted when set.
   #
   module Attributes
-    def self.included(base) # :nodoc:
-      base.class_eval do
-        extend ClassMethods
-        include InstanceMethods
-      end
+    extend ActiveSupport::Concern
+
+    def initialize(*attrs) # :nodoc:
+      self.class.attributes.each { |k, v| public_send :"#{k}=", v }
+      super *attrs
     end
 
-    module InstanceMethods # :nodoc:
+    # Returns ActiveModel compatible list of attributes and values.
+    #
+    #   class User
+    #     include Acfs::Model
+    #     attribute :name, type: String, default: 'Anon'
+    #   end
+    #   user = User.new(name: 'John')
+    #   user.attributes # => { "name" => "John" }
+    #
+    def attributes
+      self.class.attributes.keys.inject({}) { |h, k| h[k.to_s] = public_send k; h }
+    end
 
-      def initialize(*attrs) # :nodoc:
-        self.class.attributes.each { |k, v| send :"#{k}=", v }
-        super
-      end
-
-      # Returns ActiveModel compatible list of attributes and values.
-      #
-      #   class User
-      #     attribute :name, type: String, default: 'Anon'
-      #   end
-      #   user = User.new(name: 'John')
-      #   user.attributes # => { "name" => "John" }
-      #
-      def attributes
-        self.class.attributes.keys.inject({}) { |h, k| h[k.to_s] = send k; h }
+    # Update all attributes with given hash.
+    #
+    def attributes=(attributes)
+      self.attributes.each do |key, _|
+        send :"#{key}=", attributes[key] if attributes.has_key? key
       end
     end
 
@@ -49,29 +49,26 @@ module Acfs
       # setter for given attribute name. Existing methods will be overridden.
       #
       #   class User
-      #     attribute :name, type: String, default: 'Anon'
+      #     include Acfs::Model
+      #     attribute :name, :string, default: 'Anon'
       #   end
       #
-      # Available types can be found in `Acfs::Attributes::*`.
+      # Available types can be found in `Acfs::Model::Attributes::*`.
       #
-      def attribute(*attrs)
-        opts = attrs.extract_options!
-        type = opts.delete(:type) || :string
-
+      def attribute(name, type, opts = {})
         if type.is_a? Symbol or type.is_a? String
-          type = "::Acfs::Attributes::#{type.to_s.classify}".constantize
+          type = "::Acfs::Model::Attributes::#{type.to_s.classify}".constantize
         end
 
-        attrs.each do |attr|
-          define_attribute attr.to_sym, type, opts
-        end
+        define_attribute name.to_sym, type, opts
       end
 
       # Return list of possible attributes and default values for this model class.
       #
       #   class User
-      #     attribute :name, String
-      #     attribute :age, Integer, default: 25
+      #     include Acfs::Model
+      #     attribute :name, :string
+      #     attribute :age, :integer, default: 25
       #   end
       #   User.attributes # => { "name": nil, "age": 25 }
       #
@@ -79,10 +76,9 @@ module Acfs
         @attributes ||= {}
       end
 
-
       private
       def define_attribute(name, type, opts = {}) # :nodoc:
-        @attributes ||= {}
+        @attributes       ||= {}
         @attributes[name] = type.cast opts.has_key?(:default) ? opts[:default] : nil
 
         self.send :define_method, name do
@@ -101,5 +97,5 @@ end
 #
 Dir[File.dirname(__FILE__) + "/attributes/*.rb"].sort.each do |path|
   filename = File.basename(path)
-  require "acfs/attributes/#{filename}"
+  require "acfs/model/attributes/#{filename}"
 end