sinatra-active-model-serializers 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9de09c12a25df8fa91796a5574b5c532c320b6ee
+  data.tar.gz: b2e44cb5e2297efe91436422c846de165f004696
+SHA512:
+  metadata.gz: c33258af4814d0037f66deb4f7f22685c07363e1b2af47f6251469b04dff85ab4af038772371c02fab62f2cb192a95277a8d05f94e77453c069579d5f73e5244
+  data.tar.gz: b065396ae32be06bbacbc80315cd7d5a486fc7c7c6c23d349d4d02cf99477712c9dac53cd555806808e3a257d967b2d1282c715589e8f44dffb8fccf762fba2f

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+db/sinatra_active_model_serializers.sqlite3
+db/schema.rb
+sinatra-active-model-serializers-0.0.1.gem

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+gemspec
+
+group :test do
+  gem 'sinatra', '1.4.5'
+  gem 'sinatra-contrib', '1.4.2'
+  gem 'rake', '10.4.2'
+  gem 'json-schema', '2.5.0'
+  gem 'rspec', '3.1.0'
+  gem 'sinatra-activerecord', '2.0.4'
+  gem 'sqlite3', '1.3.10'
+  gem 'database_cleaner', '1.4.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Saulo da Silva Santiago
+
+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,89 @@
+[ ![Codeship Status for SauloSilva/sinatra-active-model-serializers](https://codeship.com/projects/0be149a0-8d56-0132-3f2c-5691319bff63/status?branch=master)](https://codeship.com/projects/60665)
+
+# Sinatra::ActiveModelSerializers
+
+This gem has the function of adapt the Active Model Serializers to work in Sinatra from a more practical way with models.
+If do you use everything at the default, just  require `sinatra_active_model_serializers` for serializers work correctly the a json response.
+
+## Requirements
+
+Ruby 1.9.2 or greater, Sinatra 1.4.5 or greater and Sinatra Contrib 1.4.2 or greater.
+
+## Installation
+
+`gem install sinatra-active-model-serializers`
+
+or with bundler
+
+```
+# Gemfile
+source :rubygems
+
+gem 'sinatra'
+gem 'sinatra-contrib'
+gem 'sinatra-active-record'
+gem 'sinatra-active-model-serializers'
+```
+
+## Configure
+
+First you have to being with the active record configured in your system environment correctly. If the environment is not set up, see their [documentation](https://github.com/janko-m/sinatra-activerecord#sinatra-activerecord-extension).
+After is simply do require from our library on your `application.rb`, eg.
+
+```ruby
+require 'rubygems'
+require 'sinatra-active-model-serializers'
+
+class App < Sinatra::Base
+  get '/' do
+    json Test.first
+  end
+end
+```
+
+## Options
+
+**active_model_serializers**
+
+This attribute is an object, all inserted configuration this object it will be passed on to Active Model Serializers, eg.
+
+```
+set :active_model_serializers, { root: false }
+```
+
+**serializers_path**
+
+By default this attribute is set up to look for the serializers from your project in "* app / serializers *". Whether you have a different environment you can set up by inserting the path of the string, eg.
+
+```
+set :serializers_path, './whatever_path/serializers'
+```
+
+or not to automatically requires
+
+```
+set :serializers_path, false
+```
+
+**json**
+
+When you return a json, you can send a the second parameter.
+This the second parameter is an object. This object may contain new configurations to assign to the Active Model Serializers or to rewrite any already set by default, eg.
+
+```
+get '/' do
+  json Resource.first, { root: false }
+end
+```
+
+or
+
+```
+get '/' do
+  json Resource.first, { scope: self }
+end
+```
+
+## License
+
+[MIT](https://github.com/SauloSilva/sinatra-active-model-serializers/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,7 @@
+require "sinatra/activerecord/rake"
+
+namespace :db do
+  task :load_config do
+    require "./spec/app/application"
+  end
+end

data/db/migrate/00_create_tests.rb

@@ -0,0 +1,7 @@
+class CreateTests < ActiveRecord::Migration
+  def change
+    create_table :tests do |t|
+      t.string :foo
+    end
+  end
+end

data/lib/sinatra_active_model_serializers.rb

@@ -0,0 +1,2 @@
+require 'active_model_serializers'
+require 'sinatra_active_model_serializers/json'

data/lib/sinatra_active_model_serializers/json.rb

@@ -0,0 +1,32 @@
+module Sinatra
+  SERIALIZERS_DEFAULT_PATH = './app/serializers'
+
+  module JSON
+    def initialize
+      files_required
+      super
+    end
+
+    def json(object, options={})
+      options = options.merge(settings.active_model_serializers)
+
+      serializer = ActiveModel::Serializer.serializer_for(object, options)
+
+      if serializer
+        serializer.new(object, options).to_json
+      else
+        object.to_json(options)
+      end
+    end
+
+    def files_required
+      return unless settings.serializers_path
+      Dir["#{ settings.serializers_path }/**/*.rb"].flatten.sort.each do |file|
+        require file
+      end
+    end
+  end
+
+  Base.set :active_model_serializers, {}
+  Base.set :serializers_path, SERIALIZERS_DEFAULT_PATH
+end

data/lib/sinatra_active_model_serializers/version.rb

@@ -0,0 +1,6 @@
+module SinatraActiveModelSerializers
+  PATCH = 2
+  MINOR = 0
+  MAJOR = 0
+  VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}".freeze
+end

data/sinatra-active-model-serializers.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+# Run `rake sinatra-contrib.gemspec` to update the gemspec.
+require File.expand_path('../lib/sinatra_active_model_serializers/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'sinatra-active-model-serializers'
+  s.version     = SinatraActiveModelSerializers::VERSION
+  s.description = 'Adapter from Active Model Serializers, to work in Sinatra from a more practical way with models'
+  s.homepage    = 'https://github.com/SauloSilva/sinatra-active-model-serializers'
+  s.summary     = 'Adapter from Active Model Serializers'
+
+  s.license = 'MIT'
+
+  # generated from git shortlog -sn
+  s.authors = ['saulosantiago']
+
+  # generated from git shortlog -sne
+  s.email = ['saulodasilvasantiago@gmail.com']
+
+  # generated from git ls-files
+  s.files = [
+    '.gitignore',
+    'Gemfile',
+    'LICENSE',
+    'README.md',
+    'Rakefile',
+    'db/migrate/00_create_tests.rb',
+    'db/schema.rb',
+    'lib/sinatra_active_model_serializers.rb',
+    'lib/sinatra_active_model_serializers/json.rb',
+    'lib/sinatra_active_model_serializers/version.rb',
+    'sinatra-active-model-serializers.gemspec',
+    'spec/app/application.rb',
+    'spec/app/models/test.rb',
+    'spec/app/serializers/test_serializer.rb',
+    'spec/json_spec.rb',
+    'spec/schemas/test_with_root.json',
+    'spec/schemas/test_without_root.json',
+    'spec/spec_helper.rb',
+    'spec/support/request_support.rb'
+  ]
+
+  s.add_runtime_dependency 'active_model_serializers', '0.9.3'
+end

data/spec/app/application.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require(:defaut, :test)
+
+require './lib/sinatra_active_model_serializers/'
+Dir['./spec/app/models/**/*.rb'].flatten.sort.each { |file| require file}
+
+module App
+  class Base < Sinatra::Base
+    register Sinatra::ActiveRecordExtension
+
+    set :serializers_path, './spec/app/serializers'
+
+    configure :test do
+      ActiveRecord::Base.logger = nil
+    end
+
+    set :database, {
+      adapter: 'sqlite3',
+      database: 'db/sinatra_active_model_serializers.sqlite3'
+    }
+
+    get '/with-root/' do
+      json Test.create(foo: 'bar'), { root: true }
+    end
+
+    get '/without-root/' do
+      json Test.create(foo: 'bar'), { root: false }
+    end
+  end
+end
+
+App::Base.run

data/spec/app/models/test.rb

@@ -0,0 +1,2 @@
+class Test < ActiveRecord::Base
+end

data/spec/app/serializers/test_serializer.rb

@@ -0,0 +1,7 @@
+class TestSerializer < ActiveModel::Serializer
+  attributes :foo, :bar
+
+  def bar
+    "bar"
+  end
+end

data/spec/json_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe App::Base do
+  it 'should response with root' do
+    get '/with-root/'
+    match_response_schema(:test_with_root)
+  end
+
+  it 'should response without root' do
+    get '/without-root/'
+    match_response_schema(:test_without_root)
+  end
+end

data/spec/schemas/test_with_root.json

@@ -0,0 +1,19 @@
+{
+  "type": "object",
+  "required":  [
+    "test"
+  ],
+  "properties": {
+    "test": {
+      "type": "object",
+      "required":  [
+        "foo",
+        "bar"
+      ],
+      "properties": {
+        "foo": { "type": "string" },
+        "bar": { "type": "string" }
+      }
+    }
+  }
+}

data/spec/schemas/test_without_root.json

@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "required":  [
+    "foo",
+    "bar"
+  ],
+  "properties": {
+    "foo": { "type": "string" },
+    "bar": { "type": "string" }
+  }
+}

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'sinatra'
+require 'sinatra/contrib'
+require 'app/application'
+require 'rspec'
+require 'rack/test'
+Dir[File.expand_path '../support/**/*.rb',  __FILE__].each { |file| require file }
+
+RSpec.configure do |config|
+  config.expect_with :rspec
+  include Rack::Test::Methods
+  include RequestSupport
+  DatabaseCleaner.clean_with :truncation
+  DatabaseCleaner.strategy = :transaction
+
+  before :all do
+    DatabaseCleaner.start
+  end
+
+  after :all do
+    DatabaseCleaner.clean
+  end
+
+  def app
+    App::Base
+  end
+end

data/spec/support/request_support.rb

@@ -0,0 +1,14 @@
+module RequestSupport
+  def response_body
+    JSON.parse last_response.body
+  end
+
+  def match_response_schema(schema, options={})
+    default_optitons = { strict: true, validate_schema: true }
+    schema_directory = "#{ Dir.pwd }/spec/schemas"
+    schema_path = "#{ schema_directory }/#{ schema }.json"
+
+    JSON::Validator.clear_cache
+    JSON::Validator.validate!(schema_path, response_body, default_optitons.merge(options))
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-active-model-serializers
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- saulosantiago
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+description: Adapter from Active Model Serializers, to work in Sinatra from a more
+  practical way with models
+email:
+- saulodasilvasantiago@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- db/migrate/00_create_tests.rb
+- db/schema.rb
+- lib/sinatra_active_model_serializers.rb
+- lib/sinatra_active_model_serializers/json.rb
+- lib/sinatra_active_model_serializers/version.rb
+- sinatra-active-model-serializers.gemspec
+- spec/app/application.rb
+- spec/app/models/test.rb
+- spec/app/serializers/test_serializer.rb
+- spec/json_spec.rb
+- spec/schemas/test_with_root.json
+- spec/schemas/test_without_root.json
+- spec/spec_helper.rb
+- spec/support/request_support.rb
+homepage: https://github.com/SauloSilva/sinatra-active-model-serializers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Adapter from Active Model Serializers
+test_files: []