jsonapi_utils 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 84ec82ef1641e1fd29946ff8a585a66a97cd9ba0
4
+ data.tar.gz: 1be29030137e603d3a324271751babfa6345f91f
5
+ SHA512:
6
+ metadata.gz: 94237460f45e983ec4f915d05903cefbc36ab88fbd63f1ab93eacc5f45ac27cde11221e453ccb7ea1303fc5982315afeb57c5eeb5349960f7e816e23c436d1db
7
+ data.tar.gz: 15cffa208ff216997d4be1d5f187ab627a87678d0fd57c738d82caaeb533c0bd75464370e2a7984dd676703f0d9c043930ea937cb1296383a1bdfc0dc43d0f61
Binary file
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
Binary file
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.2
4
+ before_install: gem install bundler -v 1.10.4
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in jsonapi_utils.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Tiago Guedes
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # JsonapiUtils
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jsonapi_utils`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'jsonapi_utils'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install jsonapi_utils
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jsonapi_utils. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "jsonapi_utils"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'jsonapi_utils/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "jsonapi_utils"
8
+ spec.version = JsonapiUtils::VERSION
9
+ spec.authors = ["Tiago Guedes"]
10
+ spec.email = ["tiagopog@gmail.com"]
11
+
12
+ spec.summary = %q{Full-featured JSON API serialization in a simple way}
13
+ spec.description = %q{A Rails-style way to get your API's data serialized following the JSON API's specs (http://jsosapi.org)}
14
+ spec.homepage = "https://github.com/b2beauty/jsonapi_utils"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 1.10"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ spec.add_development_dependency "rspec"
25
+ end
Binary file
Binary file
@@ -0,0 +1,3 @@
1
+ module JsonapiUtils
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,106 @@
1
+ require "jsonapi_utils/version"
2
+
3
+ module JsonapiUtils
4
+ extend ActiveSupport::Concern
5
+
6
+ include do
7
+ helper_method :jsonapi_serialize, :jsonapi_serialize_collection
8
+ end
9
+
10
+ def jsonapi_render(options)
11
+ if options.has_key?(:json)
12
+ response_body = jsonapi_serialize(options[:json], options[:options] || {})
13
+ render json: response_body, status: (options[:status] || :ok)
14
+ end
15
+ end
16
+
17
+ def jsonapi_serialize(records, options = {})
18
+ fix_request_options(params, records)
19
+ results = JSONAPI::OperationResults.new
20
+
21
+ if records.respond_to?(:to_ary)
22
+ records = fix_when_hash(records, options) if records.all? { |e| e.is_a?(Hash) }
23
+ @resources = build_collection(records)
24
+ results.add_result(JSONAPI::ResourcesOperationResult.new(:ok, @resources, result_options(options)))
25
+ else
26
+ @resource = turn_into_resource(records)
27
+ results.add_result(JSONAPI::ResourceOperationResult.new(:ok, @resource))
28
+ end
29
+
30
+ create_response_document(results).contents
31
+ end
32
+
33
+ def jsonapi_error(exception)
34
+ JSONAPI::ErrorsOperationResult.new(exception.errors[0].code, exception.errors).as_json
35
+ end
36
+
37
+ private
38
+
39
+ def fix_request_options(params, records)
40
+ return if request.method !~ /get/i ||
41
+ params.nil? ||
42
+ %w(index show create update destroy).include?(params[:action])
43
+ action = records.respond_to?(:to_ary) ? 'index' : 'show'
44
+ @request.send("setup_#{action}_action", params)
45
+ end
46
+
47
+ def result_options(options)
48
+ hash = {}
49
+
50
+ if JSONAPI.configuration.top_level_links_include_pagination
51
+ hash[:pagination_params] = pagination_params(options)
52
+ end
53
+
54
+ if JSONAPI.configuration.top_level_meta_include_record_count
55
+ hash[:record_count] = count_records(@resources, options)
56
+ end
57
+
58
+ hash
59
+ end
60
+
61
+ def pagination_params(options)
62
+ @paginator ||= paginator(params)
63
+ if @paginator && JSONAPI.configuration.top_level_links_include_pagination
64
+ options = {}
65
+ options[:record_count] = count_records(@resources, options) if @paginator.class.requires_record_count
66
+ return @paginator.links_page_params(options)
67
+ else
68
+ return {}
69
+ end
70
+ end
71
+
72
+
73
+ def build_collection(records)
74
+ return [] unless records.present?
75
+ paginator(@request.params).apply(records, nil).map do |record|
76
+ turn_into_resource(record)
77
+ end
78
+ end
79
+
80
+ def turn_into_resource(record)
81
+ @request.resource_klass.new(record)
82
+ end
83
+
84
+ def paginator(params)
85
+ PagedPaginator.new(ActionController::Parameters.new(params[:page]))
86
+ end
87
+
88
+ def fix_when_hash(records, options)
89
+ return [] unless options[:model]
90
+ records.map { |hash| options[:model].new(hash) }
91
+ rescue
92
+ ids = records.map { |e| e[:id] || e['id'] }
93
+ scope = options[:scope] ? options[:model].send(options[:scope]) : options[:model]
94
+ scope.where(id: ids)
95
+ end
96
+
97
+ def count_records(records, options)
98
+ if records.size.zero? then 0
99
+ elsif options[:count] then options[:count]
100
+ elsif options[:model] && options[:scope] then options[:model].send(options[:scope]).count
101
+ elsif options[:model] then options[:model].count
102
+ else records.first.model.class.count
103
+ end
104
+ end
105
+ end
106
+
metadata ADDED
@@ -0,0 +1,104 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: jsonapi_utils
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Tiago Guedes
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-09-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: A Rails-style way to get your API's data serialized following the JSON
56
+ API's specs (http://jsosapi.org)
57
+ email:
58
+ - tiagopog@gmail.com
59
+ executables: []
60
+ extensions: []
61
+ extra_rdoc_files: []
62
+ files:
63
+ - ".CODE_OF_CONDUCT.md.swp"
64
+ - ".gitignore"
65
+ - ".jsonapi_utils.gemspec.swp"
66
+ - ".rspec"
67
+ - ".travis.yml"
68
+ - CODE_OF_CONDUCT.md
69
+ - Gemfile
70
+ - LICENSE.txt
71
+ - README.md
72
+ - Rakefile
73
+ - bin/console
74
+ - bin/setup
75
+ - jsonapi_utils.gemspec
76
+ - lib/.jsonapi_utils.rb.swp
77
+ - lib/jsonapi_utils.rb
78
+ - lib/jsonapi_utils/.version.rb.swp
79
+ - lib/jsonapi_utils/version.rb
80
+ homepage: https://github.com/b2beauty/jsonapi_utils
81
+ licenses:
82
+ - MIT
83
+ metadata: {}
84
+ post_install_message:
85
+ rdoc_options: []
86
+ require_paths:
87
+ - lib
88
+ required_ruby_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - ">="
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ required_rubygems_version: !ruby/object:Gem::Requirement
94
+ requirements:
95
+ - - ">="
96
+ - !ruby/object:Gem::Version
97
+ version: '0'
98
+ requirements: []
99
+ rubyforge_project:
100
+ rubygems_version: 2.4.8
101
+ signing_key:
102
+ specification_version: 4
103
+ summary: Full-featured JSON API serialization in a simple way
104
+ test_files: []