shot_api_gem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fa238ed7e1c6e14edcd0eb04430b706830ece0b
+  data.tar.gz: cdd5db22f9e847b53edb93b147e5c645a0184236
+SHA512:
+  metadata.gz: aea81b0eb06b08f5c817da251db18c451fd7b4d0051f2688714ea34be23fec7451e49afa940512d66da60c1e2df39abb9c3443cfac95c4544978b85dff819449
+  data.tar.gz: 4db8e4864bee4b1f3e48fc089b100e60678efb9b0f16e8fdb905ebabadcbce79286ec138397a69b3546af1a899948a6882c4d031c44f15a41597b734b0473056

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2
+
+addons:
+  code_climate:
+    repo_token: cd5e01f67a9e9db56a3c218e1722e2e250b39cfb4abd287fd883b58186e3bef9
+
+after_script: CODECLIMATE_REPO_TOKEN=cd5e01f67a9e9db56a3c218e1722e2e250b39cfb4abd287fd883b58186e3bef9 bundle exec codeclimate-test-reporter

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at michael.ogala@andela.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Ogala
+
+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,91 @@
+[![Code Climate](https://codeclimate.com/github/andela-mogala/shot_api_gem/badges/gpa.svg)](https://codeclimate.com/github/andela-mogala/shot_api_gem)  [![Build Status](https://travis-ci.org/andela-mogala/shot_api_gem.svg?branch=master)](https://travis-ci.org/andela-mogala/shot_api_gem)
+
+# ShotApiGem
+
+Shot api gem was built out of a desire to make interactions with the [turbo-url](turbo-url.herokuapp.com) api a hassle free process. It does the job of communicating with the api and returns ruby objects that you can use directly in your code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shot_api_gem'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shot_api_gem
+
+## Usage
+This gem is intended for use directly with your ruby code. The entry point to all interactions with the turbo-url api is from the ShotApiGem::Consumer class.
+This class accepts an api key when creating an instance.
+
+### Getting an API key.
+* Create an account on [turbo-url](turbo-url.herokuapp.com) if you don't already have one
+* Visit your dashboard and find the `Generate API Key` button.
+* Clicking on this button generates an api key.
+* You can now copy this key and use it with the gem
+
+### Making requests
+Start by creating an instance of Consumer class
+
+```ruby
+resource = ShotApiGem::Consumer.new(api_key)
+```
+
+You can now call methods like
+
+```ruby
+resource.fetch_all
+```
+This returns an array of links that you have created with your account.
+
+```ruby
+resource.fetch(1)
+```
+Returns the link with `{ id: 1 }`
+
+```ruby
+resource.create({ url: 'somelink.com', slug: 'slk' })
+```
+creates a new link and returns the created link as an object
+
+```ruby
+resource.update(1, { url: 'anotherlink.com', slug: 'anlk' })
+```
+updates the link with `{ id: 1 }` and returns the updated link as an object
+
+```ruby
+resource.delete(1)
+```
+deletes the link with `{ id: 1 }` but doesn't return any content
+
+A typical Link object has the following properties:
+* id
+* url
+* slug
+* active
+* clicks
+* title
+* date_created
+* date_updated
+
+## 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/andela-mogala/shot_api_gem. 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 "shot_api_gem"
+
+# 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/lib/shot_api_gem.rb

@@ -0,0 +1,6 @@
+require "shot_api_gem/version"
+require 'shot_api_gem/link'
+require 'shot_api_gem/consumer'
+
+module ShotApiGem
+end

data/lib/shot_api_gem/consumer.rb

@@ -0,0 +1,55 @@
+require 'rest-client'
+require 'json'
+
+module ShotApiGem
+  class Consumer
+    attr_reader :header, :base_url, :local_base_url
+
+    def initialize(api_key)
+      @header = { authorization: api_key }
+      @base_url = 'http://turbo-url.herokuapp.com/api/v1/links'
+      @local_base_url = 'http://localhost:3000/api/v1/links'
+    end
+
+    def fetch_all
+      response = RestClient.get(base_url, header)
+      json_response(response.body)[:links].map do |link|
+        Link.new(link)
+      end
+    end
+
+    def fetch(id)
+      response = RestClient.get(base_url << "/#{id}", header)
+      Link.new(json_response(response.body))
+    end
+
+    def create(options)
+      response = RestClient.post(
+                   base_url,
+                   { given_url: options[:url], slug: options[:slug] },
+                   header
+                 )
+      Link.new(json_response(response.body))
+    end
+
+    def update(id, options)
+      response = RestClient.patch(
+          base_url << "/#{id}",
+          { given_url: options[:url], slug: options[:slug], active: options[:active] },
+          header
+        )
+      Link.new(json_response(response.body))
+    end
+
+    def delete(id)
+      response = RestClient.delete(base_url << "/#{id}", header)
+      response.code
+    end
+
+    private
+
+    def json_response(body)
+      JSON.parse(body, symbolize_names: true)
+    end
+  end
+end

data/lib/shot_api_gem/link.rb

@@ -0,0 +1,25 @@
+module ShotApiGem
+    class Link
+      attr_reader(
+        :id,
+        :url,
+        :slug,
+        :active,
+        :clicks,
+        :title,
+        :date_created,
+        :date_updated
+      )
+
+      def initialize(params)
+        @id = params[:id]
+        @url = params[:url]
+        @slug = params[:slug]
+        @active = params[:active]
+        @clicks = params[:clicks]
+        @title = params[:title]
+        @date_created = params[:date_created]
+        @date_updated = params[:date_updated]
+      end
+    end
+end

data/lib/shot_api_gem/version.rb

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

data/shot_api_gem.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shot_api_gem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shot_api_gem"
+  spec.version       = ShotApiGem::VERSION
+  spec.authors       = ["Michael Ogala"]
+  spec.email         = ["michael.ogala@andela.com"]
+
+  spec.summary       = %q{Pull data from turbo-url api}
+  spec.description   = %q{Interacts with the exposed api of turbo-url }
+  spec.homepage      = "https://github.com/andela-mogala/shot_api_gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'shoulda-matchers', '~> 3.1', '>= 3.1.1'
+  spec.add_development_dependency 'faker', '~> 1.6', '>= 1.6.6'
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
+  spec.add_dependency 'rest-client', '~> 2.0'
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: shot_api_gem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Ogala
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 'Interacts with the exposed api of turbo-url '
+email:
+- michael.ogala@andela.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shot_api_gem.rb
+- lib/shot_api_gem/consumer.rb
+- lib/shot_api_gem/link.rb
+- lib/shot_api_gem/version.rb
+- shot_api_gem.gemspec
+homepage: https://github.com/andela-mogala/shot_api_gem
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Pull data from turbo-url api
+test_files: []