acfs 0.2.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+*.iml
+.rakeTasks
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/.travis.yml

@@ -0,0 +1,10 @@
+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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jan Graichen
+
+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,60 @@
+# 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)
+
+TODO: Develop asynchronous parallel API client library for service oriented applications.
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acfs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acfs
+
+## Usage
+
+TODO: Write usage instructions here
+
+### Acfs::Attributes
+
+```ruby
+class MyModel
+  include Acfs::Attributes
+
+  attribute :name, :string
+  attribute :age, :integer, default: 15
+end
+
+MyModel.attributes # => { "name" => "", "age" => 15 }
+
+mo = MyModel.new name: 'Johnny', age: 12
+mo.name # => "Johnny"
+mo.age = '13'
+mo.age # => 13
+mo.attributes # => { "name" => "Johnny", "age" => 13 }
+
+```
+
+## TODO
+
+* Library Code
+* Documentation
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add specs for your feature
+4. Implement your feature
+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

data/Rakefile

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

data/acfs.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acfs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acfs"
+  spec.version       = Acfs::VERSION
+  spec.authors       = ['Jan Graichen']
+  spec.email         = %w(jg@altimos.de)
+  spec.description   = %q{API Client For Services}
+  spec.summary       = %q{An abstract API base client for service oriented application.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'activemodel'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'coveralls'
+end

data/gemfiles/Gemfile.rails-3-1

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acfs.gemspec
+gemspec path: '../'
+
+gem 'activesupport', '~> 3.1.0'
+gem 'activemodel', '~> 3.1.0'

data/gemfiles/Gemfile.rails-3-2

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acfs.gemspec
+gemspec path: '../'
+
+gem 'activesupport', '~> 3.2.0'
+gem 'activemodel', '~> 3.2.0'

data/gemfiles/Gemfile.rails-head

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acfs.gemspec
+gemspec path: '../'
+
+gem 'activesupport', github: 'rails/rails'
+gem 'activemodel', github: 'rails/rails'

data/lib/acfs.rb

@@ -0,0 +1,14 @@
+require 'active_support'
+require 'acfs/version'
+
+module Acfs
+  extend ActiveSupport::Autoload
+
+  autoload :Client
+  autoload :Base
+
+  autoload :Model
+  autoload :Attributes
+  autoload :Initialization
+
+end

data/lib/acfs/attributes.rb

@@ -0,0 +1,105 @@
+module Acfs
+
+  # == Acfs Attribute
+  #
+  # Allows to specify attributes of a class with default values and type safety.
+  #
+  #   class User
+  #     include Acfs::Attributes
+  #
+  #     attribute :name, :string, default: 'Anon'
+  #     attribute :age, :integer
+  #     attribute :special, My::Special::Type
+  #   end
+  #
+  # For each attribute a setter and getter will be created and values will be
+  # type casted when set.
+  #
+  module Attributes
+    def self.included(base) # :nodoc:
+      base.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+
+    module InstanceMethods # :nodoc:
+
+      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 }
+      end
+    end
+
+    module ClassMethods # :nodoc:
+
+      # Define a model attribute by name and type. Will create getter and
+      # setter for given attribute name. Existing methods will be overridden.
+      #
+      #   class User
+      #     attribute :name, type: String, default: 'Anon'
+      #   end
+      #
+      # Available types can be found in `Acfs::Attributes::*`.
+      #
+      def attribute(*attrs)
+        opts = attrs.extract_options!
+        type = opts.delete(:type) || :string
+
+        if type.is_a? Symbol or type.is_a? String
+          type = "::Acfs::Attributes::#{type.to_s.classify}".constantize
+        end
+
+        attrs.each do |attr|
+          define_attribute attr.to_sym, type, opts
+        end
+      end
+
+      # Return list of possible attributes and default values for this model class.
+      #
+      #   class User
+      #     attribute :name, String
+      #     attribute :age, Integer, default: 25
+      #   end
+      #   User.attributes # => { "name": nil, "age": 25 }
+      #
+      def attributes
+        @attributes ||= {}
+      end
+
+
+      private
+      def define_attribute(name, type, opts = {}) # :nodoc:
+        @attributes ||= {}
+        @attributes[name] = type.cast opts.has_key?(:default) ? opts[:default] : nil
+
+        self.send :define_method, name do
+          instance_variable_get :"@#{name}"
+        end
+
+        self.send :define_method, :"#{name}=" do |value|
+          instance_variable_set :"@#{name}", type.cast(value)
+        end
+      end
+    end
+  end
+end
+
+# Load attribute type classes.
+#
+Dir[File.dirname(__FILE__) + "/attributes/*.rb"].sort.each do |path|
+  filename = File.basename(path)
+  require "acfs/attributes/#{filename}"
+end

data/lib/acfs/attributes/integer.rb

@@ -0,0 +1,15 @@
+module Acfs::Attributes
+
+  # Integer attribute type. Use it in your model as an attribute type:
+  #
+  #   class User
+  #     attribute :name, :integer
+  #   end
+  #
+  module Integer # :nodoc:
+
+    def self.cast(obj)
+      obj.to_i
+    end
+  end
+end

data/lib/acfs/attributes/string.rb

@@ -0,0 +1,15 @@
+module Acfs::Attributes
+
+  # String attribute type. Use it in your model as an attribute type:
+  #
+  #   class User
+  #     attribute :name, :string
+  #   end
+  #
+  module String # :nodoc:
+
+    def self.cast(obj)
+      obj.to_s
+    end
+  end
+end

data/lib/acfs/client.rb

@@ -0,0 +1,15 @@
+require 'active_support/core_ext/class/attribute_accessors'
+
+module Acfs
+  module Client
+    def self.included(base)
+      base.class_eval do
+        cattr_accessor :base_url
+      end
+    end
+
+    def initialize
+
+    end
+  end
+end

data/lib/acfs/initialization.rb

@@ -0,0 +1,38 @@
+module Acfs
+  module Initialization
+
+    # Initializes a new model with the given +params+.
+    #
+    #   class User
+    #     include Acfs::Model
+    #     attribute :name
+    #     attribute :email, default: -> { "#{name}@dom.tld" }
+    #     attribute :age, :integer, default: 18
+    #   end
+    #
+    #   user = User.new(name: 'bob')
+    #   user.name  # => "bob"
+    #   user.email # => "bob@dom.tld"
+    #   user.age   # => 18
+    #
+    def initialize(params={})
+      params.each do |attr, value|
+        self.public_send("#{attr}=", value)
+      end if params
+    end
+
+    # Indicates if the model is persisted. Default is +false+.
+    #
+    #  class User
+    #    include Acfs::Model
+    #    attribute :name
+    #  end
+    #
+    #  user = User.new(name: 'bob')
+    #  user.persisted? # => false
+    #
+    def persisted?
+      false
+    end
+  end
+end

data/lib/acfs/model.rb

@@ -0,0 +1,22 @@
+require 'active_model'
+
+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
+
+          include Acfs::Initialization
+        end
+
+        include Acfs::Attributes
+      end
+    end
+  end
+end

data/lib/acfs/version.rb

@@ -0,0 +1,12 @@
+module Acfs
+  module VERSION
+    MAJOR = 0
+    MINOR = 2
+    PATCH = 0
+    STAGE = nil
+
+    STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')
+
+    def self.to_s; STRING end
+  end
+end

data/spec/attributes_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Acfs::Attributes do
+  let(:model) { Class.new(MyModel) }
+
+  describe '#initialize' do
+    before { model.send :attribute, :name, default: 'John' }
+
+    it 'should have attribute list' do
+      expect(model.new.attributes).to include('name')
+    end
+
+    it 'should set default attributes' do
+      expect(model.new.name).to be == 'John'
+    end
+  end
+
+  describe '#attributes' do
+    before do
+      model.send :attribute, :name, default: 'John'
+      model.send :attribute, :age, type: :integer, default: 25
+    end
+
+    it 'should return hash of all attributes' do
+      expect(model.new.attributes).to be == {
+          'name' => 'John',
+          'age' => 25
+      }
+    end
+  end
+
+  describe '#_getter_' do
+    before { model.send :attribute, :name, default: 'John' }
+
+    it 'should return value' do
+      expect(model.new(name: 'Paul').name).to be == 'Paul'
+    end
+
+    it 'should return default value' do
+      expect(model.new.name).to be == 'John'
+    end
+
+    it 'should return matching ivar\'s value' do
+      o = model.new
+      o.instance_variable_set :@name, 'Johannes'
+
+      expect(o.name).to be == 'Johannes'
+    end
+  end
+
+  describe '#_setter_' do
+    before { model.send :attribute, :name, default: 'John' }
+
+    it 'should set value' do
+      o = model.new
+      o.name = 'Paul'
+
+      expect(o.name).to be == 'Paul'
+    end
+
+    it 'should set instance var' do
+      o = model.new
+      o.name = 'Paul'
+
+      expect(o.instance_variable_get(:@name)).to be == 'Paul'
+    end
+
+    it 'should update attributes hash' do
+      o = model.new
+      o.name = 'Johannes'
+
+      expect(o.attributes['name']).to be == 'Johannes'
+    end
+  end
+
+  describe '.attribute' do
+    it 'should add an attribute to model attribute list' do
+      model.send :attribute, :name
+
+      expect(model.attributes).to be == { :name => '' }
+    end
+
+    it 'should accept a default value' do
+      model.send :attribute, :name, default: 'John'
+
+      expect(model.attributes).to be == { :name => 'John' }
+    end
+
+    it 'should accept an symbolic type' do
+      model.send :attribute, :age, type: :integer, default: '12'
+
+      expect(model.attributes).to be == { :age => 12 }
+    end
+
+    it 'should accept an class type' do
+      model.send :attribute, :age, type: Acfs::Attributes::Integer, default: '12'
+
+      expect(model.attributes).to be == { :age => 12 }
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Acfs::Client do
+  let(:client) { MyClient }
+
+  it "should have a base_url configuration option" do
+    client.base_url = 'http://abc.de/api/v1'
+
+    expect(client.base_url).to eq('http://abc.de/api/v1')
+  end
+
+end

data/spec/initialization_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Acfs::Initialization do
+  let(:model) { MyModel }
+
+  describe '#initialize' do
+    it 'should allow to set attributes with initializer' do
+      model = MyModel.new(name: "John")
+      expect(model.name).to be == "John"
+    end
+
+    it 'should raise error when attributes with private setters are given' do
+      expect { MyModel.new(age: 25) }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe '#persisted?' do
+    it 'should be false' do
+      expect(MyModel.new.persisted?).to be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'acfs'
+require 'coveralls'
+Coveralls.wear!
+
+Dir[File.expand_path('spec/support/**/*.rb')].each {|f| require f}
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+  config.expect_with :rspec do |c|
+    # Only allow expect syntax
+    c.syntax = :expect
+  end
+end

data/spec/support/my_client.rb

@@ -0,0 +1,12 @@
+
+class MyClient
+  include Acfs::Client
+
+end
+
+class MyModel
+  include Acfs::Model
+
+  attr_accessor :name, :age
+  private :age=
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: acfs
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Jan Graichen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API Client For Services
+email:
+- jg@altimos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acfs.gemspec
+- gemfiles/Gemfile.rails-3-1
+- gemfiles/Gemfile.rails-3-2
+- gemfiles/Gemfile.rails-head
+- lib/acfs.rb
+- lib/acfs/attributes.rb
+- lib/acfs/attributes/integer.rb
+- lib/acfs/attributes/string.rb
+- lib/acfs/client.rb
+- lib/acfs/initialization.rb
+- lib/acfs/model.rb
+- lib/acfs/version.rb
+- spec/attributes_spec.rb
+- spec/client_spec.rb
+- spec/initialization_spec.rb
+- spec/spec_helper.rb
+- spec/support/my_client.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 956482736488803723
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 956482736488803723
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: An abstract API base client for service oriented application.
+test_files:
+- spec/attributes_spec.rb
+- spec/client_spec.rb
+- spec/initialization_spec.rb
+- spec/spec_helper.rb
+- spec/support/my_client.rb