acfs 0.25.0.1.b232 → 0.26.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTFmMzdiODEwYTc1M2IxOWU5YmNjMzljYjVmNjU4MjYwYTdkZDgyMg==
-  data.tar.gz: !binary |-
-    NzFiNjNhNDQ5NjIyNmVlODI0YzEwZTljYTBjNTU4Y2E0YjFmMTdkMw==
+SHA1:
+  metadata.gz: ef03d133e909f75c3e309db36a37b2ebebb5f5c0
+  data.tar.gz: db0c0ef2f2d97301ceb1b66ebdc3e7262d282b4b
 SHA512:
-  metadata.gz: !binary |-
-    M2E5MTdiYjg1NzAyY2Y1NGNhNWVkNDBjZTdhMjY3ZWNmNTc2NjcxNjk2OWZi
-    YTQzMjcxNGFkN2UxODc3ZGIwY2E0MTdkMGI5YTNmZGRkYTVjMDg2ODEwMzA0
-    NmVhZWI5NzMyOWM4OWJmYjQ5NWU4ZGJhOThlMDZlYzUzNjMxMTc=
-  data.tar.gz: !binary |-
-    YWVhNzAzY2FkYzY0ZjlmYzhlOTg3OWZkNzNmNDFhMmY1ZTM0NDZjYjkyOWUx
-    YjYwM2JjYTg1ZjhkOGY1YWY1NjdlMzcyYTI0ZGQzYjc4ZTJhNzljOGIwYzY1
-    YTk0Y2ZiYjRkYTQ0MGQ2NTk0MjhkYWFiZmMwNGNjODk3NDczOWY=
+  metadata.gz: 9633fb9b9f3ac0357f03cb64c37f48066e28d6ba7238292fcaac8b448e297ad1b6c1f4c42a66f09e3be9e33423e215977f6ce2f573d611d8b5a30df48eb5809d
+  data.tar.gz: 52dcbf542450575eb7525e03e4a96e0bff46995cd756125be96ebee6f7386be53691b32859684e0543d34eee0b289f99ab838123f3f8a7d67d6f7994f53abadb

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.26.0
+
+* Add support for singleton resources (Nicolas Fricke)
+
 ## 0.25.0
 
 * Add option to allow blank attribute values (Johannes Jasper)

data/lib/acfs.rb

@@ -19,6 +19,7 @@ module Acfs
   require 'acfs/response'
   require 'acfs/runner'
   require 'acfs/service'
+  require 'acfs/singleton_resource'
 
   extend Global
 

data/lib/acfs/operation.rb

@@ -20,8 +20,6 @@ module Acfs
       @data     = (opts[:data]   || {}).dup
 
       @callback = block
-
-      raise ArgumentError, 'ID parameter required for READ, UPDATE and DELETE operation.' if single? and id.nil?
     end
 
     def single?

data/lib/acfs/singleton_resource.rb

@@ -0,0 +1,92 @@
+module Acfs
+
+  # Acfs SingletonResources
+  #
+  # Usage explanation:
+  #   Single.find      => sends GET    request to http://service:port/single
+  #   my_single.save   => sends POST   request to http://service:port/single if my_single is a new object
+  #                    or sends PUT    request to http://service:port/single if my_single has been requested before
+  #   my_single.delete => sends DELETE request to http://service:port/single
+  #
+  # SingletonResources do not support the Resource method :all, since
+  # always only a single instance of the resource is being returned
+  #
+  class SingletonResource < Acfs::Resource
+
+    # @api public
+    #
+    # Return true if model is a new record and was not saved yet.
+    #
+    # Checks weather object is loaded via delegator or not, since
+    # the id-attribute is not required for singletons this check
+    # cannot check for existence of value in id-attribute
+    #
+    # @return [Boolean] True if resource is newly created, false otherwise.
+    #
+    def new?
+      !loaded?
+    end
+    alias :new_record? :new?
+
+    # @api public
+    #
+    # Destroy resource by sending a DELETE request.
+    # Will raise an error in case something goes wrong.
+    #
+    # Deleting a resource is a synchronous operation.
+    #
+    # @raise [Acfs::ErroneousResponse]
+    #   If remote service respond with not successful response.
+    # @return [undefined]
+    # @see #delete
+    #
+    def delete!(opts = {})
+      opts[:params] ||= {}
+
+      operation :delete, opts do |data|
+        update_with data
+        freeze
+      end
+    end
+
+    class << self
+      # @api public
+      #
+      # @overload find(id, opts = {})
+      #   Find a singleton resource, optionally with params.
+      #
+      #   @example
+      #     single = Singleton.find # Will query `http://base.url/singletons/`
+      #
+      #   @param [ Hash ] opts Additional options.
+      #   @option opts [ Hash ] :params Additional parameters added to request.
+      #
+      #   @yield [ resource ] Callback block to be executed after resource was fetched successfully.
+      #   @yieldparam resource [ self ] Fetched resources.
+      #
+      #   @return [ self ] Resource object.
+      #
+      def find(*attrs, &block)
+        opts = { params: attrs.extract_options! }
+
+        model = ResourceDelegator.new self.new
+
+        operation :read, opts do |data|
+          model.__setobj__ create_resource data, origin: model.__getobj__
+          block.call model unless block.nil?
+        end
+
+        model
+      end
+
+      # @api public
+      #
+      # Undefined, raises NoMethodError.
+      # A singleton always only returns one object, therefore the
+      # methods :all and :where are not defined.
+      #
+      undef_method :all
+      undef_method :where
+    end
+  end
+end

data/lib/acfs/version.rb

@@ -1,7 +1,7 @@
 module Acfs
   module VERSION
     MAJOR = 0
-    MINOR = 25
+    MINOR = 26
     PATCH = 0
     STAGE = nil
 

data/spec/acfs_spec.rb

@@ -56,6 +56,72 @@ describe 'Acfs' do
     expect(@user.age).to be == 26
   end
 
+  describe 'singleton' do
+    before do
+      stub_request(:get, 'http://users.example.org/singles?user_id=5').to_return response({ score: 250, user_id: 5 })
+    end
+
+    it 'should create a singleton resource' do
+      stub = stub_request(:post, 'http://users.example.org/singles').to_return response({ score: 250, user_id: 5 })
+
+      @single = Single.new user_id: 5, score: 250
+      expect(@single.new?).to eq true
+
+      @single.save
+      expect(stub).to have_been_requested
+
+      expect(@single.new?).to eq false
+      expect(@single.user_id).to eq 5
+      expect(@single.score).to eq 250
+    end
+
+    it 'should load singleton resource' do
+      @single = Single.find user_id: 5
+      Acfs.run
+
+      expect(@single.score).to eq 250
+    end
+
+    it 'should update singleton resource' do
+      stub = stub_request(:put, 'http://users.example.org/singles').to_return { |request| {
+          body: request.body,
+          headers: { 'Content-Type' => request.headers['Content-Type'] }
+      } }
+
+      @single = Single.find user_id: 5
+      Acfs.run
+
+      expect(@single.score).to eq 250
+
+      @single.score = 300
+      @single.save
+
+      expect(stub).to have_been_requested
+
+      expect(@single.score).to eq 300
+    end
+
+    it 'should delete singleton resource' do
+      stub = stub_request(:delete, 'http://users.example.org/singles').to_return { |request| {
+          body: request.body,
+          headers: { 'Content-Type' => request.headers['Content-Type'] }
+      } }
+
+      @single = Single.find user_id: 5
+      Acfs.run
+
+      expect(@single.new?).to eq false
+
+      @single.delete
+
+      expect(stub).to have_been_requested
+    end
+
+    it 'should raise error when calling `all\'' do
+      expect {Single.all}.to raise_error(NoMethodError)
+    end
+  end
+
   it 'should load multiple single resources' do
     @users = MyUser.find(2, 3, 100) do |users|
       # This block should be called only after *all* resources are loaded.

data/spec/spec_helper.rb

@@ -10,6 +10,9 @@ if ENV['CI'] || (defined?(:RUBY_ENGINE) && RUBY_ENGINE != 'rbx')
   end
 end
 
+require 'bundler'
+Bundler.require
+
 require 'acfs'
 
 Dir[File.expand_path('spec/support/**/*.rb')].each {|f| require f}

data/spec/support/service.rb

@@ -68,6 +68,13 @@ class Mac < Computer
 
 end
 
+class Single < Acfs::SingletonResource
+  service UserService
+
+  attribute :score, :integer
+  attribute :user_id, :integer
+end
+
 # DRAFT: Singular resource
 #class Singular < Acfs::Resource
 #  service UserService, singular: true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.25.0.1.b232
+  version: 0.26.0
 platform: ruby
 authors:
 - Jan Graichen
@@ -14,84 +14,84 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.6.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.6.5
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -172,6 +172,7 @@ files:
 - lib/acfs/runner.rb
 - lib/acfs/service.rb
 - lib/acfs/service/middleware.rb
+- lib/acfs/singleton_resource.rb
 - lib/acfs/stub.rb
 - lib/acfs/version.rb
 - lib/acfs/yard.rb
@@ -213,17 +214,17 @@ 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: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: An abstract API base client for service oriented application.