serialization_extender 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Rakefile

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

data/lib/serialization_extender.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+require 'serialization_extender/version'
+require 'ruby_interface'
+module SerializationExtender
+  extend RubyInterface
+  
+  interface :serialization_extender do
+    class_attribute :profiles
+    self.profiles ||= {}
+    def self.profile(name, options = {}, &blk)
+      self.profiles = profiles.merge name => { :options => options, :blk => blk }
+    end
+    
+    interfaced do
+      alias_method_chain :serializable_hash, :extending
+    end
+
+    def apply(options = nil)
+      options = options.dup if options
+      profile = (options && options.delete(:profile)) || Thread.current["_serialization_profile"] || :default
+      calculated_options, blk = get_params profile, options
+      res = owner.serializable_hash_without_extending calculated_options
+      blk ? owner.instance_exec(res, &blk) : res
+    end
+    
+    protected
+    def get_params(profile_name, options = nil)
+      profile = self.profiles[profile_name]
+      return [options, nil] unless profile
+      [options_merge(options ? options : {}, profile[:options]), profile[:blk]]
+    end
+    
+    def options_merge(o1, o2)
+      o2.each do |k, v|
+        case o1[k]
+        when Hash
+          o1[k] = options_merge o1[k], o2[k]
+        when Array
+          o1[k] += v
+        else
+          o1[k] = v
+        end
+      end
+      o1
+    end
+    
+  end
+  
+  def serializable_hash_with_extending(options = nil)
+    serialization_extender.apply options
+  end
+end

data/lib/serialization_extender/version.rb

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

data/lib/userbase_client/user_spec.rb

@@ -0,0 +1,248 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe UserbaseClient::User do
+  before(:each) do
+    @host = UserbaseClient.config.host
+    @params = {'login' => "nick"}
+    @guid = "GUID"
+  end
+
+  shared_examples_for "стандартный успешный ответ" do
+    it "результат метода должен быть хешом" do
+      stub_request(:any, @path).to_return(:body => "{}")
+      @request.call.should be_instance_of(Hash)
+    end
+  end
+
+  shared_examples_for "стандартный неуспешный ответ" do
+    it "должен поднимать UserbaseClient::RecordNotFound при коде ответа 404" do
+      stub_request(:any, @path).to_return(:status => 404)
+      @request.should raise_error(UserbaseClient::RecordNotFound)
+    end
+
+    it "должен поднимать UserbaseClient::BadRequestError при коде ответа 400" do
+      stub_request(:any, @path).to_return(:status => 400)
+      @request.should raise_error(UserbaseClient::BadRequestError)
+    end
+
+    it "должен поднимать UserbaseClient::ConnectionError при коде ответа 500" do
+      stub_request(:any, @path).to_return(:status => 500)
+      @request.should raise_error(UserbaseClient::ConnectionError)
+    end
+
+    it "должен поднимать UserbaseClient::ConnectionError при таймауте" do
+      stub_request(:any, @path).to_timeout
+      @request.should raise_error(UserbaseClient::ConnectionError)
+    end
+  end
+
+  describe ".create" do
+    before(:each) do
+      @path = "http://" + @host + "/v1/users.json"
+      stub_request(:any, @path).to_return(:body => "{}")
+      @request = lambda {UserbaseClient::User.create @params }
+      @result = @request.call
+    end
+
+    it_should_behave_like "стандартный успешный ответ"
+    it_should_behave_like "стандартный неуспешный ответ"
+
+    it "должен запрашиваться /v1/users.json через POST" do
+      WebMock.should have_requested(:post, @path)
+    end
+
+    it "передаваемые параметры должны попадать в запрос" do
+      WebMock.should have_requested(:post, @path).with(:body => @params)
+    end
+  end
+
+  describe ".update" do
+    before(:each) do
+      @path = "http://" + @host + "/v1/users/#{@guid}/attributes.json"
+      stub_request(:any, @path).to_return(:body => "{}")
+      @request = lambda { UserbaseClient::User.update @guid, @params }
+      @result = @request.call
+    end
+
+    it_should_behave_like "стандартный успешный ответ"
+    it_should_behave_like "стандартный неуспешный ответ"
+    
+    it "должен запрашиваться /v1/users/GUID/attributes.json через POST" do
+      WebMock.should have_requested(:put, @path)
+    end
+
+    it "передаваемые параметры должны попадать в запрос" do
+      WebMock.should have_requested(:put, @path).with(:body => @params)
+    end
+  end
+
+  describe ".find_by_guid" do
+    before(:each) do
+      @path = "http://" + @host + "/v1/users/#{@guid}.json"
+      @request = lambda { UserbaseClient::User.find_by_guid @guid }
+    end
+    
+    it_should_behave_like "стандартный успешный ответ"
+    it_should_behave_like "стандартный неуспешный ответ"
+
+    context "успешный запрос" do
+      before(:each) do
+        stub_request(:any, @path).to_return(:body => Yajl::Encoder.encode(@params))
+        @result = @request.call
+      end
+  
+      it "должен запрашиваться /v1/users/GUID.json через GET" do
+        WebMock.should have_requested(:get, @path)
+      end
+  
+      it "должен возвращать распарсенные параметры ответа" do
+        @result.should == @params
+      end
+    end
+  end
+
+  describe ".destroy" do
+    before(:each) do
+      @path = "http://" + @host + "/v1/users/#{@guid}.json"
+      stub_request(:any, @path).to_return(:body => "{}")
+      @request = lambda { UserbaseClient::User.destroy @guid }
+      @result = @request.call
+    end
+
+    it_should_behave_like "стандартный успешный ответ"
+    it_should_behave_like "стандартный неуспешный ответ"
+    
+    it "должен запрашиваться /v1/users/GUID.json через DELETE" do
+      WebMock.should have_requested(:delete, @path)
+    end
+  end
+
+  describe ".find_attribute" do
+    before(:each) do
+      @path = "http://" + @host + "/v1/users/#{@guid}/attributes/#{@params.keys.first}.json"
+      stub_request(:any, @path).to_return(:body => Yajl::Encoder.encode(@params))
+      @request = lambda { UserbaseClient::User.find_attribute @guid, @params.keys.first }
+      @result = @request.call
+    end
+
+    it_should_behave_like "стандартный неуспешный ответ"
+    
+    it "должен запрашиваться /v1/users/GUID/attributes/ATTRIBUTE.json через GET" do
+      WebMock.should have_requested(:get, @path)
+    end
+
+    it "должен возвращать распарсенные параметры ответа" do
+      @result.should == @params[@params.keys.first]
+    end
+  end
+  
+  describe ".find_attributes" do
+    before(:each) do
+      @params = {"login" => "my_login", "name" => "Nick"}
+      @path = "http://" + @host + "/v1/users/#{@guid}.json?" + {:attrs => @params.keys}.to_param
+      stub_request(:any, @path).to_return(:body => Yajl::Encoder.encode(@params))
+      @request = lambda { UserbaseClient::User.find_attributes @guid, @params.keys }
+    end
+    
+    context "с выполненным запросом" do
+      before(:each) do
+        @result = @request.call
+      end
+
+      it_should_behave_like "стандартный неуспешный ответ"
+      
+      it "должен возвращать распарсенные параметры ответа" do
+        @result.should include(@params)
+      end
+    end
+
+    it "должен запрашиваться /v1/users/GUID.json через GET" do
+      stub_request(:any, @path).to_return(:body => Yajl::Encoder.encode(@params))
+      @result = @request.call
+      WebMock.should have_requested(:get, @path)
+    end
+  end
+
+  describe ".destroy_attributes" do
+    context "один атрибут" do
+      before(:each) do
+        @path = "http://" + @host + "/v1/users/#{@guid}/attributes.json?" + {:attrs => [@params.keys.first]}.to_param
+        stub_request(:any, @path).to_return(:body => "{}")
+        @request = lambda { UserbaseClient::User.destroy_attributes @guid, @params.keys.first }
+        @result = @request.call
+      end
+  
+      it_should_behave_like "стандартный успешный ответ"
+      it_should_behave_like "стандартный неуспешный ответ"
+      
+      it "должен запрашиваться /v1/users/GUID/attributes.json через DELETE" do
+        WebMock.should have_requested(:delete, @path)
+      end
+    end
+    
+    context "несколько атрибутов" do
+      before(:each) do
+        @path = "http://" + @host + "/v1/users/#{@guid}/attributes.json?" + {:attrs => @params.keys}.to_param
+        stub_request(:any, @path).to_return(:body => "{}")
+        @request = lambda { UserbaseClient::User.destroy_attributes @guid, @params.keys }
+        @result = @request.call
+      end
+  
+      it_should_behave_like "стандартный успешный ответ"
+      it_should_behave_like "стандартный неуспешный ответ"
+      
+      it "должен запрашиваться /v1/users/GUID/attributes.json через DELETE" do
+        WebMock.should have_requested(:delete, @path).with(:attrs => @params.keys.first)
+      end
+    end
+  end
+  
+  describe ".authenticate" do
+    before(:each) do
+      @path = "http://" + @host + "/v1/sessions.json"
+      stub_request(:any, @path).to_return(:body => Yajl::Encoder.encode({:guid => @guid}), :content_type => 'application/json')
+    end
+
+    context "без указания атрибутов" do
+      before(:each) do
+        @request = lambda { UserbaseClient::User.authenticate @params.values.first, "pass" }
+      end
+
+      it "не должен поднимать ошибок" do
+        @request.should_not raise_error
+      end
+
+      it "должен отправлять POST запрос с логином и паролем" do
+        @request.call
+        WebMock.should have_requested(:post, @path).with(:body =>  @params.merge('password' => 'pass'))
+      end
+    end
+
+    context "с указанием параметров" do
+      before(:each) do
+        @request = lambda { UserbaseClient::User.authenticate @params.values.first, "pass", ["guid", "login"] }
+        @result = @request.call
+      end
+  
+      it_should_behave_like "стандартный неуспешный ответ"
+      
+      it "должен запрашиваться /v1/sessions.json через POST" do
+        WebMock.should have_requested(:post, @path)
+      end
+  
+      it "передаваемые параметры должны попадать в запрос" do
+        WebMock.should have_requested(:post, @path).with(:body => @params.merge('password' => 'pass', 'attrs' => ['guid', 'login']))
+      end
+  
+      it "должен возвращать GUID при наличии guid в ответе" do
+        @result.should be_true
+      end
+  
+      it "должен возвращать false при статусе ответа 401" do
+        stub_request(:any, @path).to_return(:status => 401)
+        @request.call.should be_false
+      end
+    end
+  end
+end

data/lib/userbase_client_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe UserbaseClient do
+  it "должен устанавливаться хост" do
+    UserbaseClient.config.host = 'example.com'
+    UserbaseClient.config.host.should == 'example.com'
+  end
+
+  it "должен присутствовать хост по умолчанию" do
+    UserbaseClient.config.host.should_not be_empty
+  end
+
+  it "конфигурация должна происзводиться через блок" do
+    UserbaseClient.config do |config|
+      config.host = "example3.com"
+    end
+    UserbaseClient.config.host.should == 'example3.com'
+  end
+
+  it "конфигурация должна происзводиться через блок после простой конфигурации" do
+    UserbaseClient.config.host = 'example.com'
+    UserbaseClient.config do |config|
+      config.host = "example4.com"
+    end
+    UserbaseClient.config.host.should == 'example4.com'
+  end
+end

data/serialization_extender.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "serialization_extender/version"
+
+Gem::Specification.new do |s|
+  s.name        = "serialization_extender"
+  s.version     = SerializationExtender::VERSION
+  s.authors     = ["Andrew Rudenko", "Nick Recobra"]
+  s.email       = ["ceo@prepor.ru"]
+  s.homepage    = "http://github.com/Undev/serialization_extender"
+  s.summary     = %q{JSON serialization profiles.}
+  s.description = %q{Multiple JSON serialization profiles for your ActiveModel objects.}
+
+  s.rubyforge_project = "serialization_extender"
+  s.add_dependency 'ruby-interface', '>= 0.0.6'
+  s.add_development_dependency 'rspec', '>= 2.6.0'
+  s.add_development_dependency 'activemodel', '>= 3.0.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/lib/serialization_extender_spec.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'active_model'
+
+describe SerializationExtender do
+  let(:klass) do
+    Class.new do
+      include ActiveModel::Serializers::JSON
+      include SerializationExtender
+      serialization_extender do
+        profile :default, :methods => [:extended_foo]
+      end
+      attr_accessor :foo, :bar
+
+      def attributes
+        @attributes ||= { 'foo' => 'nil', 'bar' => 'nil' }
+      end
+
+      def self.name
+        "Obj"
+      end
+
+      def extended_foo
+        "extended foo"
+      end
+    end
+  end
+
+  let(:obj) { klass.new }
+
+  it "should include `extended_foo` serialization result" do
+    obj.as_json['obj'][:extended_foo].should eq("extended foo")
+  end
+
+  context "multiple profiles" do
+    before do
+      klass.serialization_extender.profile :short, :only => [:foo]
+    end
+
+    it "should serialize only `foo`" do
+      obj.foo = "fee"
+      obj.as_json(:profile => :short)['obj'].should eq({ "foo" => "fee" })
+    end
+  end
+
+  context "with block" do
+    before do
+      klass.serialization_extender.profile :custom do |res|
+        res.merge :custom => "cu"
+      end
+    end
+
+    it "should add `custom`" do
+      obj.foo = "fee"
+      res = obj.as_json(:profile => :custom)['obj']
+      res["foo"].should eq("fee")
+      res[:custom].should eq("cu")
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require 'rubygems'
+require 'rspec'
+require 'serialization_extender'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: serialization_extender
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Rudenko
+- Nick Recobra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-interface
+  requirement: &2153532040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153532040
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153531540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153531540
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &2153531080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153531080
+description: Multiple JSON serialization profiles for your ActiveModel objects.
+email:
+- ceo@prepor.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/serialization_extender.rb
+- lib/serialization_extender/version.rb
+- lib/userbase_client/user_spec.rb
+- lib/userbase_client_spec.rb
+- serialization_extender.gemspec
+- spec/lib/serialization_extender_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/Undev/serialization_extender
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: serialization_extender
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: JSON serialization profiles.
+test_files:
+- spec/lib/serialization_extender_spec.rb
+- spec/spec_helper.rb