jsend 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e216bf7f39d1a52c90163fa55102aba32fb13632
+  data.tar.gz: bba5752e6b78d8989d81e772f2fc2fdd7242dc11
+SHA512:
+  metadata.gz: d768930f37d2cafb3913b25eebcd614fe2a8924cd45106b2ef72c3ad0d1b9b95de928d6e0e0694fcab17e2e32f157d0b7029c06d275c334e27e2e12baa4e220c
+  data.tar.gz: d768ab734b7c73742140d2d9c901a532c01c1aa8be747abe320f943951629cd5406f8d1b6858b971dcbdabec4a3fee5996a11c88771ab0190ff20b0a048bab47

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+jsend

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alvaro@alvaromaceda.es. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alvaro Maceda
+
+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,73 @@
+# JSend
+
+JSend facilitates a simple jsend implementation for ruby. You can generate and parse JSend messages
+
+For more info about JSend refer to https://labs.omniti.com/labs/jsend
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsend'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsend
+
+## Usage
+
+You can generate sucess, error and failure messages:
+```ruby
+JSend.success(banana: 'gross michel').to_json
+```
+This will generate the following string:
+```
+"{\"status\":\"success\",\"data\":{\"hola\":\"caracola\"}}"
+```
+Corresponding to this JSon:
+```
+{
+  "status":"success",
+  "data": {"banana":"gross michel"}
+}
+```
+
+It works the same way with failure messages:
+```ruby
+JSend.fail(data)
+```
+
+And error messages, with or withouth error code and data
+```ruby
+jsend_message = JSend.error(error_message)
+jsend_message = JSend.error(error_message, error_code, data)
+```
+
+Unlike other libraries, you can also parse JSon strings. It will raise an error if the string can't be parsed to a Jsend message:
+```ruby
+response = JSend.parse(last_response.body)
+expect(response.success?).to eq(true)
+puts response.data
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amaceda/jsend-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jsend"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jsend.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsend/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jsend'
+  spec.version       = JSend::VERSION
+  spec.authors       = ['Alvaro Maceda']
+  spec.email         = ['alvaro@alvaromaceda.es']
+
+  spec.summary       = 'Generates and parses JSend style JSON messages'
+  # spec.description   = %q(TODO: Write a longer description or delete this line.
+  spec.homepage      = 'https://github.com/AlvaroMaceda/jsend-ruby'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = ['>=2.0.0']
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jsend.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'jsend/version'
+require 'json'
+
+require_relative 'jsend/responses/success_response'
+require_relative 'jsend/responses/fail_response'
+require_relative 'jsend/responses/error_response'
+require_relative 'jsend/parser/parser'
+
+module JSend
+
+  SUCCESS = 'success'
+  ERROR = 'error'
+  FAIL = 'fail'
+
+  def parse(json)
+    values = JSON.parse(json)
+    Parser.parser_for(values['status']).response_from_hash(values)
+  end
+
+  def success(data)
+    SucessResponse.new(data)
+  end
+
+  def fail(error_data)
+    FailResponse.new(error_data)
+  end
+
+  def error(msg, code = nil, data = nil)
+    ErrorResponse.new(data, msg, code)
+  end
+
+  module_function :parse, :success, :fail, :error
+
+end

data/lib/jsend/hash_utils.rb

@@ -0,0 +1,15 @@
+module JSend
+
+  class HashUtils
+    def self.remove_fields(hash, fields)
+      hash.keep_if { |x| !fields.include? x }
+    end
+
+    def self.has_fields_different_from(hash, fields)
+      not remove_fields(hash.clone, fields).empty?
+    end
+  end
+
+  private_constant :HashUtils
+
+end

data/lib/jsend/parser/error_message_parser.rb

@@ -0,0 +1,19 @@
+require_relative '../hash_utils'
+require_relative '../responses/error_response'
+
+module JSend
+
+  class ErrorMessageParser
+
+    def self.response_from_hash(hash)
+      raise InvalidData if hash['message'].nil?
+      raise InvalidData if HashUtils.has_fields_different_from(hash, %w(status message code data))
+
+      ErrorResponse.new hash['data'],hash['message'],hash['code']
+    end
+
+  end
+
+  private_constant :ErrorMessageParser
+
+end

data/lib/jsend/parser/exceptions.rb

@@ -0,0 +1,14 @@
+module JSend
+
+  class InvalidType < StandardError
+    def message
+      'Unsupported type of message'
+    end
+  end
+
+  class InvalidData < StandardError
+    def message
+      'Incorrect JSend message'
+    end
+  end
+end

data/lib/jsend/parser/fail_message_parser.rb

@@ -0,0 +1,19 @@
+require_relative '../hash_utils'
+require_relative '../responses/fail_response'
+
+module JSend
+
+  class FailMessageParser
+
+    def self.response_from_hash(hash)
+      raise InvalidData if hash['data'].nil?
+      raise InvalidData if HashUtils.has_fields_different_from(hash, %w(status data))
+
+      FailResponse.new hash['data']
+    end
+
+  end
+
+  private_constant :FailMessageParser
+
+end

data/lib/jsend/parser/parser.rb

@@ -0,0 +1,31 @@
+require_relative 'exceptions'
+require_relative 'success_message_parser'
+require_relative 'error_message_parser'
+require_relative 'fail_message_parser'
+
+module JSend
+
+  class Parser
+
+    def self.parser_for(type)
+      case type
+      when JSend::SUCCESS
+        SuccessMessageParser
+      when JSend::ERROR
+        ErrorMessageParser
+      when JSend::FAIL
+        FailMessageParser
+      else
+        raise JSend::InvalidType
+      end
+    end
+
+  end
+
+  private_constant :Parser
+  private_constant :SuccessMessageParser
+  private_constant :ErrorMessageParser
+  private_constant :FailMessageParser
+
+end
+

data/lib/jsend/parser/success_message_parser.rb

@@ -0,0 +1,19 @@
+require_relative '../hash_utils'
+require_relative '../responses/success_response'
+
+module JSend
+
+  class SuccessMessageParser
+
+    def self.response_from_hash(hash)
+      raise InvalidData if hash['data'].nil?
+      raise InvalidData if HashUtils.has_fields_different_from(hash, %w(status data))
+
+      SucessResponse.new hash['data']
+    end
+
+  end
+
+  private_constant :SuccessMessageParser
+
+end

data/lib/jsend/responses/error_response.rb

@@ -0,0 +1,22 @@
+require_relative 'response'
+
+module JSend
+
+  class ErrorResponse < Response
+
+    attr_reader :data, :message, :code
+
+    def initialize(data = nil, msg = nil, code = nil)
+      @status = JSend::ERROR
+      @data = data
+      @message = msg
+      @code = code
+    end
+
+    public_class_method :new
+
+  end
+
+  private_constant :ErrorResponse
+
+end

data/lib/jsend/responses/fail_response.rb

@@ -0,0 +1,20 @@
+require_relative 'response'
+
+module JSend
+
+  class FailResponse < Response
+
+    attr_reader :data
+
+    def initialize(data)
+      @status = JSend::FAIL
+      @data = data
+    end
+
+    public_class_method :new
+
+  end
+
+  private_constant :FailResponse
+
+end

data/lib/jsend/responses/response.rb

@@ -0,0 +1,27 @@
+module JSend
+
+  class Response
+
+    def to_json
+      data = {status: @status, message: @message, code: @code, data: @data}
+      relevant_data = data.keep_if { |_, v| !v.nil? }
+      relevant_data.to_json
+    end
+
+    def success?
+      @status == JSend::SUCCESS
+    end
+
+    def fail?
+      @status == JSend::FAIL
+    end
+
+    def error?
+      @status == JSend::ERROR
+    end
+
+    private_class_method :new
+
+  end
+
+end

data/lib/jsend/responses/success_response.rb

@@ -0,0 +1,20 @@
+require_relative 'response'
+
+module JSend
+
+  class SucessResponse < Response
+
+    attr_reader :data
+
+    def initialize(data)
+      @status = JSend::SUCCESS
+      @data = data
+    end
+
+    public_class_method :new
+
+  end
+
+  private_constant :SucessResponse
+
+end

data/lib/jsend/version.rb

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

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: jsend
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alvaro Maceda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- alvaro@alvaromaceda.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsend.gemspec
+- lib/jsend.rb
+- lib/jsend/hash_utils.rb
+- lib/jsend/parser/error_message_parser.rb
+- lib/jsend/parser/exceptions.rb
+- lib/jsend/parser/fail_message_parser.rb
+- lib/jsend/parser/parser.rb
+- lib/jsend/parser/success_message_parser.rb
+- lib/jsend/responses/error_response.rb
+- lib/jsend/responses/fail_response.rb
+- lib/jsend/responses/response.rb
+- lib/jsend/responses/success_response.rb
+- lib/jsend/version.rb
+homepage: https://github.com/AlvaroMaceda/jsend-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Generates and parses JSend style JSON messages
+test_files: []