fson 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17bfd7f187015864d738f9b5a460bdefd845eb25
-  data.tar.gz: 843bc84ed8bbb0f326cc8e66a709dec22649d9fe
+  metadata.gz: 8cddfef5d630ad5cf03719127dcbd0e8a5fa4236
+  data.tar.gz: c116041b17ede76525c20f74f5c8258bf19b3fad
 SHA512:
-  metadata.gz: d09d1d708e8b03065375ded5bdf6e7e5688710ccb05b699d35608e4361dd5fcc5160058f8353287601cdc6b34bd1f463a7594ab19d7bb74fc4f057122b57a79d
-  data.tar.gz: ab36d815a9db5df6923f49fe7bfa6f4389e7ad67f4609697e00c404775533057749c881392d550f341785441b47fa9fb935aee1651df6309ea2aee40be3adfd8
+  metadata.gz: cb5cd1db604ab6d2309466e17800193a94386fbf75f745d2c5d4f19f3227a8cfc86e206ea1adf55e15d29f1d627d1459384dbcc0bbc0077edd1bbe8c86c3a01b
+  data.tar.gz: 45307d3145080234ea52640fc2f2c72596e2f675773d5b4a5625c49b2d8a20b37813b5c16e44b9b74870a19234c8735434881532c8b2fbf24f44d189c8e13c9f

data/.ruby-gemset

@@ -0,0 +1 @@
+fson

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.2
+addons:
+  code_climate:
+    repo_token: bc20ea9e0d0b4ea4346a7902a4fe20294f373cc5817137880503b4803d9e6017

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'rspec'
+gem 'oj', '~> 2.12.10'
+
+group :test do
+  gem 'codeclimate-test-reporter', require: nil
+end

data/Gemfile.lock

@@ -1,13 +1,16 @@
 PATH
   remote: .
   specs:
-    fson (0.0.1)
-      oj (~> 2.12)
+    fson (0.0.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.3)
     oj (2.12.10)
     rake (10.4.2)
     rspec (3.3.0)
@@ -23,11 +26,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  codeclimate-test-reporter
   fson!
+  oj (~> 2.12.10)
   rake (~> 10.4)
-  rspec
+  rspec (~> 3.3)

data/README.md

@@ -1 +1,159 @@
-# Fson - JSON API Response Fluent Builder
+## Description
+
+Fson is a fluent builder for simple JSON API responses
+
+[![Build Status](https://travis-ci.org/mkluczny/fson.svg?branch=develop)](https://travis-ci.org/mkluczny/fson)
+[![Dependency Status](https://gemnasium.com/mkluczny/fson.svg)](https://gemnasium.com/mkluczny/fson)
+[![Code Climate](https://codeclimate.com/github/mkluczny/fson/badges/gpa.svg)](https://codeclimate.com/github/mkluczny/fson)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fson'
+
+for Rails projects also
+ 
+    rails g fson:install
+    
+## Usage
+
+Create response builder
+
+```ruby
+Fson::Response.new()                # {}
+```
+    
+with given status
+
+```ruby
+Fson::Response.new('failure')       # {"status": "failure"}
+```
+    
+or use one of predefined factory methods
+
+```ruby
+Fson::Response.success              # {"status": "success"}
+Fson::Response.error                # {"status": "error"}
+Fson::Response.fail                 # {"status": "fail"}
+```
+    
+then add some data by passing hash
+
+```ruby
+.data({:id => 12})                  
+```
+
+```json
+{
+    "data": {
+          "id": 12
+     }
+}
+```
+    
+or defining block
+
+```ruby
+.data { |data|
+    data[:id] = 12
+}                                   
+```
+
+```json
+{
+    "data": {
+        "id": 12
+    }
+}
+```
+    
+optionally add errors
+
+```ruby
+.error('not authorized') { |e| 
+    e[:code] = 401
+}.error('null pointer exception')
+```
+
+```json
+{ 
+    "errors": [
+        {
+            "message": "not authorized",
+            "code": 401
+        },
+        {
+            "message": "null pointer exception"
+        }
+    ]
+}
+```
+    
+and finally get JSON with
+
+```ruby
+.as_json
+```
+    
+## Example
+
+Builder chain
+
+```ruby
+Fson::Response.fail.data {|data| data[:id] = 12}.error('not authorized').as_json
+```
+    
+will return
+
+```json
+{
+    "status": "fail", 
+    "data": {
+        "id": 12
+    },
+    "errors": [
+        {
+            "message": "not authorized"
+        }
+    ]
+}
+```    
+
+## Custom builders
+
+You can add custom builder methods operating on response hash objects
+
+```ruby
+@_response      # top level response hash
+@_data          # data hash
+@_errors        # errors hash
+```
+
+For example you can add builder
+
+```ruby
+module MyCustomBuilder
+    
+    def attribute(value)
+        @_data[:attribute] = value
+        self
+    end
+end
+```
+
+by registering it in initializer
+ 
+```ruby
+require 'fson/loader'
+
+::Fson::Loader::configure([MyCustomBuilder])
+```
+    
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,8 +1,8 @@
-# require "bundler/gem_tasks"
-# require "rspec/core/rake_task"
-# require 'rspec/core/rake_task'
-#
-# RSpec::Core::RakeTask.new
-#
-# task :default => :spec
-# task :test    => :spec
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test    => :spec

data/fson.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.name        = 'fson'
   s.version     = Fson::VERSION
 
-  s.summary     = 'Simple fluent builder for API JSON responses'
+  s.summary     = 'Fluent builder for API JSON responses'
   s.description = 'Building simple JSON responses with fluent builder'
 
   s.authors     = ['Mateusz Kluczny']
@@ -18,7 +18,6 @@ Gem::Specification.new do |s|
   s.executables  = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_path = ['lib']
 
-  s.add_runtime_dependency     'oj',    '~> 2.12'
   s.add_development_dependency 'rspec', '~> 3.3'
   s.add_development_dependency 'rake',  '~> 10.4'
 end

data/lib/fson/builder.rb

@@ -1,5 +1,5 @@
 module Fson
-  module Fson::Builder
+  module Builder
 
     def data(data = nil, &block)
       if data
@@ -15,12 +15,13 @@ module Fson
       self
     end
 
-    def error(message, id = nil)
-      @_errors << { :message => message }.tap {|error|
-        unless id.nil?
-          error[:id] = id
-        end
-      }
+    def error(message, &block)
+      error = { :message => message }
+
+      yield(error) if block_given?
+
+      @_errors << error
+
       self
     end
   end

data/lib/fson/loader.rb

@@ -0,0 +1,11 @@
+require 'fson/response'
+
+module Fson
+  module Loader
+    def self.configure(classes)
+      classes.each { |clazz|
+        Fson::Response.send(:include, clazz)
+      }
+    end
+  end
+end

data/lib/fson/response.rb

@@ -12,16 +12,18 @@ module Fson
     # Constructor
     ##
 
-    def initialize(status)
-      @_response = {
-          :status => status
-      }
+    def initialize(status = nil)
+      @_response = {}
       @_data     = {}
       @_errors   = []
+
+      unless status.nil?
+        @_response[:status] = status
+      end
     end
 
     def as_json
-      ::Oj.dump(build)
+      ::Oj.dump(build, :mode => :compat)
     end
 
     class << self

data/lib/fson/version.rb

@@ -1,3 +1,3 @@
 module Fson
-  VERSION = '0.0.4'
+  VERSION   = '0.0.6'
 end

data/lib/generators/fson/install_generator.rb

@@ -0,0 +1,14 @@
+module Fson
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def create_initializer
+        template 'initializer.rb', File.join('config', 'initializers', 'fson.rb')
+      end
+    end
+  end
+end

data/lib/generators/fson/templates/initializer.rb

@@ -0,0 +1,3 @@
+require 'fson/loader'
+
+::Fson::Loader::configure([])

data/spec/fson/response/as_json_spec.rb

@@ -7,11 +7,11 @@ describe ::Fson::Response do
     it 'should return json response' do
       # given
       response = ::Fson::Response.error
-                     .error('invalid', 'text-set-1')
+                     .error('invalid') { |e| e[:id] = 'text-set-1'}
                      .data { |data| data[:author] = 'Mateusz Kluczny' }
 
       # when/then
-      expect(response.as_json).to eq("{\":status\":\":error\",\":data\":{\":author\":\"Mateusz Kluczny\"},\":errors\":[{\":message\":\"invalid\",\":id\":\"text-set-1\"}]}")
+      expect(response.as_json).to eq("{\"status\":\"error\",\"data\":{\"author\":\"Mateusz Kluczny\"},\"errors\":[{\"message\":\"invalid\",\"id\":\"text-set-1\"}]}")
     end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,4 @@
-require 'fson'
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'fson'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fson
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Mateusz Kluczny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.12'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +46,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -67,8 +56,11 @@ files:
 - fson.gemspec
 - lib/fson.rb
 - lib/fson/builder.rb
+- lib/fson/loader.rb
 - lib/fson/response.rb
 - lib/fson/version.rb
+- lib/generators/fson/install_generator.rb
+- lib/generators/fson/templates/initializer.rb
 - spec/fson/response/as_json_spec.rb
 - spec/fson/response/error_spec.rb
 - spec/fson/response/fail_spec.rb
@@ -95,10 +87,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Simple fluent builder for API JSON responses
+summary: Fluent builder for API JSON responses
 test_files:
 - spec/fson/response/as_json_spec.rb
 - spec/fson/response/error_spec.rb