reply 0.2.0 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/reply/reply.rb

@@ -1,30 +1,42 @@
 class Reply
-  attr_accessor :status, :code, :messages, :data
+  # simple_status either 0, 1, 2
+  # status can be any code e.g. 200, 401
+  attr_accessor :status, :data
+  attr_reader :simple_status, :messages
 
-  STATUS_ERROR = 0
-  STATUS_SUCCESS = 1
-  STATUS_WARNING = 2
+  SIMPLE_STATUS_ERROR = 0
+  SIMPLE_STATUS_SUCCESS = 1
+  SIMPLE_STATUS_WARNING = 2
+  SIMPLE_STATUSES = [SIMPLE_STATUS_SUCCESS, SIMPLE_STATUS_WARNING, SIMPLE_STATUS_ERROR]
 
   def initialize(params={})
     @messages = params[:messages] || []
-    @status = params[:status] || STATUS_SUCCESS
     @data = params[:data] || {}
-    @code = params[:code] || nil
+    @status = params[:status] || nil
+    @simple_status = params[:simple_status] || SIMPLE_STATUS_SUCCESS
   end
 
-  def clear_messages
-    @messages.clear
+  def simple_status=(s)
+    raise(ArgumentError) unless SIMPLE_STATUSES.include?(s)
+    @simple_status = s
   end
 
-  def add_message(message)
-    @messages << message
+  #-------------------------------------------------------------------------
+  # 
+  #-------------------------------------------------------------------------
+
+  def clear_messages
+    @messages.clear
   end
 
-  def add_messages(array)
+  def add_messages(array_or_str)
+    array = wrap_arr(array_or_str)
     @messages = @messages | array
   end
+  alias :add_message :add_messages
 
-  def replace_messages(array)
+  def replace_messages(array_or_str)
+    array = wrap_arr(array_or_str)
     @messages = array
   end
 
@@ -32,42 +44,62 @@ class Reply
     @messages = object.errors.full_messages
   end
 
-  def add_error(message)
-    add_message(message)
+  def add_errors(array_or_str)
+    add_messages(array_or_str)
     mark_as_error
   end
+  alias :add_error :add_errors
 
-  def add_errors(array)
-    add_messages(array)
-    mark_as_error
+  def mark_as_success
+    @simple_status = SIMPLE_STATUS_SUCCESS
   end
+  alias :success! :mark_as_success
 
   def mark_as_error
-    @status = STATUS_ERROR
+    @simple_status = SIMPLE_STATUS_ERROR
   end
   alias :error! :mark_as_error
 
   def mark_as_warning
-    @status = STATUS_WARNING
+    @simple_status = SIMPLE_STATUS_WARNING
   end
   alias :warning! :mark_as_warning
 
-  def mark_as_success
-    @status = STATUS_SUCCESS
-  end
-  alias :success! :mark_as_success
+  #-------------------------------------------------------------------------
+  # Predicates
+  #-------------------------------------------------------------------------
 
   def success?
-    @status == STATUS_SUCCESS
+    @simple_status == SIMPLE_STATUS_SUCCESS
   end
   alias :successful? :success?
 
   def error?
-    @status == STATUS_ERROR
+    @simple_status == SIMPLE_STATUS_ERROR
   end
   alias :failure? :error?
 
   def warning?
-    @status == STATUS_WARNING
+    @simple_status == SIMPLE_STATUS_WARNING
   end
+
+  private
+
+    # Wraps the object in an Array unless it's an Array.  Converts the
+    # object to an Array using #to_ary if it implements that.
+    def wrap_arr(object)
+      case object
+      when nil
+        []
+      when Array
+        object
+      else
+        if object.respond_to?(:to_ary)
+          object.to_ary
+        else
+          [object]
+        end
+      end
+    end
+
 end

data/readme.md

@@ -42,6 +42,13 @@ Usage
 
   # add some data to the reply
   reply.data = something
+
+  # add a status to the reply
+  # this is independent of success, error and warning
+  reply.status = 401
+
+  # copy all the errors from an active record object
+  reply.replace_messages_with_errors_for(active_record_object)
 ```
 
 Copyright

data/reply.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "reply"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sebastian Porto"]
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/sporto/reply"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.17"
+  s.rubygems_version = "1.8.25"
   s.summary = "An standarized reply object"
 
   if s.respond_to? :specification_version then

data/spec/lib/reply/reply_spec.rb

@@ -12,14 +12,70 @@ describe Reply do
   end
 
   let(:reply) { Reply.new }
-  let(:invalid_object) { Monkey.new }
 
-  it "is invalid" do
-    expect(invalid_object).not_to be_valid
+  describe '.simple_status' do
+
+    it "is successful by default" do
+      expect(reply).to be_successful
+    end
+
+    it 'can be set in the initialiser' do
+      reply = Reply.new(simple_status: 0)
+      expect(reply).to be_error
+    end
+
+    it 'can be set' do
+      reply.simple_status = 2
+      expect(reply).to be_warning
+    end
+
+    it 'rejects unknown' do
+      expect{ reply.simple_status = 4 }.to raise_error
+    end
+  end
+
+  describe '.status' do
+    it 'can be set in the initialiser' do
+      reply = Reply.new(status: 401)
+      expect(reply.status).to eq(401)
+    end
+
+    it 'can be set' do
+      reply.status = 400
+      expect(reply.status).to eq(400)
+    end
+  end
+
+  describe '.replace_messages' do
+
+    it 'accepts an array' do
+      arr = [1,2]
+      reply.replace_messages(arr)
+      expect(reply.messages).to eq(arr)
+    end
+
+    it 'accepts a string' do
+      str = 'x'
+      reply.replace_messages(str)
+      expect(reply.messages).to eq([str])
+    end
+
   end
 
-  it "is successful by default" do
-    expect(reply).to be_successful
+  describe '.add_messages' do
+
+    it 'accepts an array' do
+      arr = [1,2]
+      reply.add_messages(arr)
+      expect(reply.messages).to eq(arr)
+    end
+
+    it 'accepts a string' do
+      str = 'x'
+      reply.add_messages(str)
+      expect(reply.messages).to eq([str])
+    end
+
   end
 
   describe ".add_error" do
@@ -50,14 +106,17 @@ describe Reply do
     end
   end
 
-  describe ".replace_messages_with_errors_for" do
-    before do
-      invalid_object.valid?
-      reply.replace_messages_with_errors_for(invalid_object)
+  describe ".mark_as_success" do
+    it "marks the reply as success" do
+      reply.mark_as_success
+      expect(reply).to be_successful
     end
+  end
 
-    it "copies the messages" do
-      expect(reply.messages.size).to eq(1)
+  describe ".success!" do
+    it "marks the reply as success" do
+      reply.success!
+      expect(reply).to be_successful
     end
   end
 
@@ -75,20 +134,6 @@ describe Reply do
     end
   end
 
-  describe ".mark_as_success" do
-    it "marks the reply as success" do
-      reply.mark_as_success
-      expect(reply).to be_successful
-    end
-  end
-
-  describe ".success!" do
-    it "marks the reply as success" do
-      reply.success!
-      expect(reply).to be_successful
-    end
-  end
-
   describe ".mark_as_warning" do
     it "marks the reply as warning" do
       reply.mark_as_warning
@@ -103,4 +148,22 @@ describe Reply do
     end
   end
 
+  describe ".replace_messages_with_errors_for" do
+    let(:invalid_object) { Monkey.new }
+
+    before do
+      invalid_object.valid?
+      reply.replace_messages_with_errors_for(invalid_object)
+    end
+
+    it "is invalid" do
+      expect(invalid_object).not_to be_valid
+    end
+
+    it "copies the messages" do
+      expect(reply.messages.size).to eq(1)
+    end
+  end
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reply
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152636520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152636520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2152635460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152635460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2152650400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *2152650400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2152649400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2152649400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2152648800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: 1.8.7
   type: :development
   prerelease: false
-  version_requirements: *2152648800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
 - !ruby/object:Gem::Dependency
   name: active_attr
-  requirement: &2152648080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +101,12 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *2152648080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: An standarized reply object
 email: s@porto5.com
 executables: []
@@ -116,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 204553621348656513
+      hash: -1892639974551080489
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -125,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: An standarized reply object