jsonplaceholder_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 193d476d403f97e2172bb4e9c21a7b2873dea455b134816776427032360e1ce5
+  data.tar.gz: 42a901a5012b023fa0f67c3ad4ac2aeeccd763b377c3888ebabcab54124c548b
+SHA512:
+  metadata.gz: fd5665be0a7639c52b4cf6bd6a3c41c29ce0f6c475b8e9e1c1026cb09e431bd233e4af0b8d397349634277bce3c7a45a844fc5bdb06b35c3608829fb0f937267
+  data.tar.gz: 207c9a333cc7313cc50b684f560901c455744b713bacb5757321b21cffaa83819334f840121f6d98abcc2561f03e40038da21f717393c25dd688dd0eee59479d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

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 philiplambok71@gmail.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonplaceholder_api.gemspec
+gemspec
+
+gem 'faraday'
+gem 'pry'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    jsonplaceholder_api (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    faraday (1.0.0)
+      multipart-post (>= 1.2, < 3)
+    method_source (0.9.2)
+    multipart-post (2.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday
+  jsonplaceholder_api!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Philip Lambok
+
+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,59 @@
+# JsonplaceholderApi
+
+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/jsonplaceholder_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonplaceholder_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jsonplaceholder_api
+
+## Usage
+
+Experimental project to designing good api wrapper. 
+
+```rb
+# create client object
+client = JsonplaceholderApi::Client.new
+
+# find posts
+client.posts.all.to_json #> [{ id: 10, title: 'Post title', body: 'Post body' }]
+
+# find spesific post
+client.posts.find(2) #> { id: 2, title: 'Post title', body: 'Post body' }
+
+# find comments in spesific post
+post = client.posts.find(2)
+post.comments.to_json #> [{ id: 5, user_id: 12, body: 'This is sample comment' }]
+```
+
+## 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/[USERNAME]/jsonplaceholder_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jsonplaceholder_api/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the JsonplaceholderApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jsonplaceholder_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'jsonplaceholder_api'
+
+# 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(__FILE__)

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/jsonplaceholder_api.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/jsonplaceholder_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jsonplaceholder_api'
+  spec.version       = JsonplaceholderApi::VERSION
+  spec.authors       = ['Philip Lambok']
+  spec.email         = ['philiplambok71@gmail.com']
+
+  spec.summary       = 'A ruby wrapper to JSONPlaceholder api'
+  spec.description   = 'A ruby wrapper to JSONPlaceholder api'
+  spec.homepage      = 'https://github.com/philiplambok/jsonplaceholder_api'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = "https://rubygems.org/"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/philiplambok/jsonplaceholder_api'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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']
+end

data/lib/jsonplaceholder_api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'jsonplaceholder_api/version'
+require 'jsonplaceholder_api/client'
+require 'pry'
+
+module JsonplaceholderApi
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/jsonplaceholder_api/api/comment.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'jsonplaceholder_api/json_parser'
+
+module JsonplaceholderApi
+  module Api
+    class Comment
+      PATH = '/comments'
+
+      include JsonParser
+
+      def initialize(client)
+        @client = client
+      end
+
+      def find(id)
+        url = "#{PATH}/#{id}"
+        @response = @client.get(url)
+        self
+      end
+    end
+  end
+end

data/lib/jsonplaceholder_api/api/post.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'jsonplaceholder_api/json_parser'
+
+module JsonplaceholderApi
+  module Api
+    class Post
+      include JsonParser
+
+      PATH = '/posts'
+
+      def initialize(client)
+        @client = client
+      end
+
+      def all
+        @response = @client.get(PATH)
+        self
+      end
+
+      def find(id)
+        @id = id
+        url = "#{PATH}/#{@id}"
+        @response = @client.get(url)
+        self
+      end
+
+      def comments
+        url = "#{PATH}/#{@id}/comments"
+        @response = @client.get(url)
+        self
+      end
+    end
+  end
+end

data/lib/jsonplaceholder_api/client.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'jsonplaceholder_api/api/post'
+require 'jsonplaceholder_api/api/comment'
+require 'jsonplaceholder_api/http_request'
+
+module JsonplaceholderApi
+  class Client
+    include HttpRequest
+
+    def initialize; end
+
+    def posts
+      @posts ||= Api::Post.new(self)
+    end
+
+    def comments
+      @comments ||= Api::Comment.new(self)
+    end
+  end
+end

data/lib/jsonplaceholder_api/http_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module JsonplaceholderApi
+  module HttpRequest
+    BASE_URL = 'https://jsonplaceholder.typicode.com'
+
+    def get(path, params = {})
+      url = "#{BASE_URL}#{path}"
+      response = Faraday.get url, params
+      response.body
+    end
+  end
+end

data/lib/jsonplaceholder_api/json_parser.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module JsonplaceholderApi
+  module JsonParser
+    def to_json(*_args)
+      JSON.parse(@response)
+    end
+  end
+end

data/lib/jsonplaceholder_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JsonplaceholderApi
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: jsonplaceholder_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Philip Lambok
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-11 00:00:00.000000000 Z
+dependencies: []
+description: A ruby wrapper to JSONPlaceholder api
+email:
+- philiplambok71@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonplaceholder_api-0.1.0.gem
+- jsonplaceholder_api.gemspec
+- lib/jsonplaceholder_api.rb
+- lib/jsonplaceholder_api/api/comment.rb
+- lib/jsonplaceholder_api/api/post.rb
+- lib/jsonplaceholder_api/client.rb
+- lib/jsonplaceholder_api/http_request.rb
+- lib/jsonplaceholder_api/json_parser.rb
+- lib/jsonplaceholder_api/version.rb
+homepage: https://github.com/philiplambok/jsonplaceholder_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/philiplambok/jsonplaceholder_api
+  source_code_uri: https://github.com/philiplambok/jsonplaceholder_api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper to JSONPlaceholder api
+test_files: []