shortify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebafabf02946fcee72e8fecd6d30e5596b2a952c
+  data.tar.gz: 0d63c82bb6ac27a5336e6d039b471eb07f1d5f29
+SHA512:
+  metadata.gz: ce094916bde26368ce6ed79ed3559cd5431e7921490e6e9a8e1e7aab622c97b122efc34e95d9eeb222c0afc1b8f63c8565a4f3db1809607ddc8feb03622d7f2f
+  data.tar.gz: 6f19aa0d104fa8d1c31ebac099f5d104a5cf8bfdefd50d534c1515e9ad16db84de90373b48b780f7e267564bd8c2519af83250bd7ad70ebe4b0125fa5c441d90

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/.rubocop.yml

@@ -0,0 +1,17 @@
+---
+AllCops:
+  Exclude:
+    - "bin/*"
+    - "vendor/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.1
+
+before_install:
+  - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
+  - gem install bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+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.
+
+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, age, or religion.
+
+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.
+
+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.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+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

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+group :development, :test do
+  gem "rake", "~> 10.0"
+  gem "rspec", "~> 3.2"
+  gem "rubocop", "~> 0.30"
+  gem "vcr", "~> 2.9"
+  gem "webmock", "~> 1.21"
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 pseudomuto
+
+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,52 @@
+# Shortify
+
+[![Build Status](https://travis-ci.org/shortify/shortify-ruby.svg?branch=master)](https://travis-ci.org/shortify/shortify-ruby)
+
+A ruby client library for working with Shortify
+
+## Installation
+
+```ruby
+gem "shortify"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shortify
+
+## Usage
+
+```ruby
+def make_short_url(full_url)
+  # assumes you're hosting your shortify instance at http://short.ly
+  # for SSL, provide the scheme and host. E.g. https://short.ly
+  client = Shortify::Client.new("short.ly", "username", "password")
+  client.short_url_for(full_url)
+rescue Shortify::Error => e
+  # do something with the error
+end
+```
+
+**Error Types**
+
+* `Shortify::AuthenticationError` - bad credentials
+* `Shortify::ParamsError` - bad url parameter
+* `Shortify::Error` - anything else
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/shortify/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shortify"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shortify.rb

@@ -0,0 +1,10 @@
+require "httparty"
+
+module Shortify
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class ParamsError < Error; end
+end
+
+require "shortify/version"
+require "shortify/client"

data/lib/shortify/client.rb

@@ -0,0 +1,38 @@
+class Shortify::Client
+  CREATE_ENDPOINT = "/redirects".freeze
+
+  attr_reader :base_uri, :username, :password
+
+  def initialize(base_uri, username, password)
+    @base_uri = HTTParty.normalize_base_uri(base_uri)
+    @username = username
+    @password = password
+  end
+
+  def short_url_for(target_url)
+    post_options = options.merge(body: { url: target_url }.to_json)
+    response = HTTParty.post(CREATE_ENDPOINT, post_options)
+    fail error_for_response(response) unless response.key?("token")
+
+    URI.parse("#{base_uri}/#{response['token']}") if response.key?("token")
+  end
+
+  private
+
+  def options
+    @options ||= {
+      base_uri: base_uri,
+      basic_auth: { username: username, password: password }
+    }
+  end
+
+  def error_for_response(response)
+    message = response["text"]
+
+    case response["code"].to_i
+    when 401 then Shortify::AuthenticationError.new(message)
+    when 422 then Shortify::ParamsError.new(message)
+    else Shortify::Error.new(message)
+    end
+  end
+end

data/lib/shortify/version.rb

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

data/shortify.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shortify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "shortify"
+  spec.version       = Shortify::VERSION
+  spec.authors       = ["pseudomuto"]
+  spec.email         = ["david.muto@gmail.com"]
+
+  spec.summary       = "A ruby client library for working with Shortify"
+  spec.description   = "A ruby client library for working with Shortify"
+  spec.homepage      = "https://github.com/shortify/shortify-ruby"
+  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_dependency "httparty"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: shortify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pseudomuto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby client library for working with Shortify
+email:
+- david.muto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shortify.rb
+- lib/shortify/client.rb
+- lib/shortify/version.rb
+- shortify.gemspec
+homepage: https://github.com/shortify/shortify-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A ruby client library for working with Shortify
+test_files: []