ok_linker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb9cf79a26e604c19c75c3409fb9adfbad3d2934
+  data.tar.gz: e967b848f07355fc4e297c9f7af5f09947427e76
+SHA512:
+  metadata.gz: 241d6903dcacf3c14a02cd8f1801a49ef70b440ae332cb834e37b530b40f902c1026efc24d29840e66f63470d601d7339a178affee46f8e74013b9dee1be3b80
+  data.tar.gz: 66ec91ff6d0024d649ca1a524c27e836615f02ca0e100c99195b3d515650b14da7a952b0a7358cec9bcf95b7acb95ea16ba1e8d9180d5648cdb69013db2bfb54

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.idea/
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Ilya Bodrov
+
+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,80 @@
+# OkLinker
+[![Dependency Status](https://gemnasium.com/bodrovis/ok_linker.svg)](https://gemnasium.com/bodrovis/ok_linker)
+
+Ruby gem to work with Odnoklassniki's URL shortening service [okey.link](http://okey.link).
+
+## Installation
+
+Via RubyGems:
+
+    $ gem install ok_linker
+
+Or add it to your `Gemfile`:
+
+    gem 'ok_linker' 
+
+## Usage
+
+### Prerequisites
+
+First of all, you will require access to [okey.link](https://okey.link). Fill in this [submission form](https://okey.link/cabinet/registration)
+to gain access.
+
+After logging in, copy your API access token from the [API section](https://okey.link/cabinet/api). This token
+has unlimited lifetime and has to be stored securely.
+
+### Configuration
+
+OkLinker does not require much configuration. The only thing that you need to provide is your access token.
+You can either use an initializer (for example, `ok_linker.rb`):
+
+    OkLinker.configure do |c|
+      c.access_token = 'Your token'
+    end
+
+or provide it when instantiating a new client:
+
+    client = OkLinker::Client.new(access_token: 'Your token')
+
+### Calling methods
+
+You can read more about available methods [here](https://okey.link/cabinet/api).
+
+OkLinker provides the following conventional methods:
+
+```ruby
+shorten(url)        # Shorten a given URL
+
+hide(url)           # Hide a URL that was previously shorten
+
+clicks(url)         # Get clicks statistics for the given URL
+
+count_urls(params)  # Get a list of shortened URLS.
+                    # Allowed options:
+                    # * :epp  - integer, optional. Elements per page. Default is 20.
+                    # * :page - integer, optional. Page to fetch. Default is 1.
+```
+
+Also, you can call raw methods:
+
+```ruby
+get(method, params = {}, &block)
+
+post(method, params = {}, &block)
+```
+
+For example,
+
+    client.get('get-urls', page: 2)
+    
+These methods always return JSON or one of the errors listed [here](https://github.com/bodrovis/ok_linker/blob/master/lib/ok_linker/error.rb#L18).
+
+## Todo
+
+* Write tests
+
+## License
+
+Licensed under the [MIT License](https://github.com/bodrovis/ok_linker/blob/master/LICENSE).
+
+Copyright (c) 2015 [Ilya Bodrov](http://radiant-wind.com)

data/lib/ok_linker.rb

@@ -0,0 +1,31 @@
+require 'pry'
+require 'faraday'
+require 'faraday_middleware'
+require 'multi_json'
+
+require_relative 'ok_linker/connection'
+require_relative 'ok_linker/request'
+require_relative 'ok_linker/version'
+require_relative 'ok_linker/error'
+require_relative 'ok_linker/config'
+require_relative 'ok_linker/client'
+
+module OkLinker
+  class << self
+    attr_accessor :config
+
+    def new(options = {})
+      OkLinker::Client.new(options)
+    end
+
+    def configure
+      @config = OkLinker::Config.new
+      yield @config
+      @config
+    end
+
+    def options
+      (@config && @config.options) || {}
+    end
+  end
+end

data/lib/ok_linker/client.rb

@@ -0,0 +1,52 @@
+module OkLinker
+  class Client
+    def initialize(attrs = {})
+      attrs = OkLinker.options.merge(attrs)
+      Config::VALID_OPTIONS_KEYS.each do |key|
+        instance_variable_set("@#{key}".to_sym, attrs[key])
+      end
+    end
+
+    def shorten(url)
+      post('make-short-url', url: url.to_s)
+    end
+
+    def hide(url)
+      post('hide-url', url: url.to_s)
+    end
+
+    def clicks(url)
+      get('get-url-clicks', url: url.to_s)
+    end
+
+    def count_urls(params = {})
+      get('get-urls', params)
+    end
+
+    def get(method, params = {}, &block)
+      request_method(:get, method, params, block)
+    end
+
+    def post(method, params = {}, &block)
+      request_method(:post, method, params, block)
+    end
+
+    private
+
+    def request_method(http_method, method, params, block)
+      response = request.send(http_method, method, params)
+      response = block.call response if block
+      response
+    end
+
+    def request
+      @request ||= Request.new(credentials)
+    end
+
+    def credentials
+      {
+          access_token:    @access_token
+      }
+    end
+  end
+end

data/lib/ok_linker/config.rb

@@ -0,0 +1,24 @@
+module OkLinker
+  class Config
+    VALID_OPTIONS_KEYS = [:access_token].freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.configure
+      config = self.new
+      yield config
+      config
+    end
+
+    def initialize(options={})
+      @access_token = options[:access_token] || options['access_token']
+    end
+
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{ |name| options[name] = send(name) }
+      options
+    end
+
+  end
+end

data/lib/ok_linker/connection.rb

@@ -0,0 +1,24 @@
+module OkLinker
+  module Connection
+    API_HOST = 'https://okey.link/api/v1'
+
+    def connection(token = '')
+      options = {
+          :headers => {
+              :accept => 'application/json',
+              :user_agent => "ok_linker ruby gem/#{OkLinker::VERSION}",
+              :'Access-Token' => token
+          },
+          :url => "#{API_HOST}/"
+      }
+
+      client = Faraday.default_adapter
+
+      Faraday.new(options) do |conn|
+        conn.request :multipart
+        conn.request :url_encoded
+        conn.adapter client
+      end
+    end
+  end
+end

data/lib/ok_linker/error.rb

@@ -0,0 +1,38 @@
+module OkLinker
+  class Error < StandardError
+    ClientError = Class.new(self)
+    ServerError = Class.new(self)
+
+    # HTTP status code 400 - invalid params
+    BadRequest = Class.new(ClientError)
+
+    # HTTP status code 401 - not authorized
+    Unauthorized = Class.new(ClientError)
+
+    # HTTP status code 403 - invalid token
+    Forbidden = Class.new(ClientError)
+
+    # HTTP status code 501 - not implemented
+    NotImplemented = Class.new(ServerError)
+
+    ERRORS = {
+        200 => OkLinker::Error::ClientError,
+        400 => OkLinker::Error::BadRequest,
+        401 => OkLinker::Error::Unauthorized,
+        403 => OkLinker::Error::Forbidden,
+        501 => OkLinker::Error::NotImplemented
+    }
+
+    class << self
+      # Create a new error from an HTTP response
+      def from_response(body)
+        new(body.to_s)
+      end
+    end
+
+    # Initializes a new Error object
+    def initialize(message = '')
+      super(message)
+    end
+  end
+end

data/lib/ok_linker/request.rb

@@ -0,0 +1,50 @@
+module OkLinker
+  class Request
+    include OkLinker::Connection
+    attr_reader :access_token
+
+    def initialize(credentials)
+      @access_token = credentials[:access_token]
+    end
+
+    def get(path, params = {})
+      respond perform_request(:get, path, params)
+    end
+
+    def post(path, params = {})
+      respond perform_request(:post, path, params)
+    end
+
+    private
+
+    def perform_request(method, path, params)
+      connection(access_token).send(method) do |req|
+        req.url path
+        if method == :get
+          req.params = params
+        else
+          req.body = params
+        end
+      end
+    end
+
+    def respond(response)
+      begin
+        MultiJson.load(response.body)
+      rescue MultiJson::ParseError
+        return_error(response.status, response.body)
+      end
+    end
+
+    def return_error(code, body)
+      fail error(code, body)
+    end
+
+    def error(code, body)
+      unless [200, 201].include?(code)
+        klass = OkLinker::Error::ERRORS[code]
+        klass.from_response(body)
+      end
+    end
+  end
+end

data/lib/ok_linker/version.rb

@@ -0,0 +1,3 @@
+module OkLinker
+  VERSION = '0.0.1'
+end

data/ok_linker.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path("../lib/ok_linker/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "ok_linker"
+  spec.version       = OkLinker::VERSION
+  spec.authors       = ["Ilya Bodrov"]
+  spec.email         = ["golosizpru@gmail.com"]
+  spec.summary       = %q{Ruby gem for okey.link API.}
+  spec.description   = %q{Ruby gem for Odnoklassniki's URL shortening service okey.link.}
+  spec.homepage      = "https://github.com/bodrovis/ok_linker"
+  spec.license       = "MIT"
+  spec.platform      = Gem::Platform::RUBY
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday",            "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.9"
+  spec.add_dependency "multi_json",         "~> 1.11"
+
+  spec.add_development_dependency "rake",   "~> 10.4"
+  spec.add_development_dependency "rspec",  "~> 3.4"
+  spec.add_development_dependency "pry",    "0.10.3"
+  spec.add_development_dependency "vcr",    "~> 3.0", ">= 3.0.0"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: ok_linker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ilya Bodrov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Ruby gem for Odnoklassniki's URL shortening service okey.link.
+email:
+- golosizpru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/ok_linker.rb
+- lib/ok_linker/client.rb
+- lib/ok_linker/config.rb
+- lib/ok_linker/connection.rb
+- lib/ok_linker/error.rb
+- lib/ok_linker/request.rb
+- lib/ok_linker/version.rb
+- ok_linker.gemspec
+homepage: https://github.com/bodrovis/ok_linker
+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.5.0
+signing_key: 
+specification_version: 4
+summary: Ruby gem for okey.link API.
+test_files: []
+has_rdoc: