relinkly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: efe951a2ac0f57738160775af7e0ae5d7233527c057eb65fe6b93a96d764fe0b
+  data.tar.gz: 8676c1129862ca4e14cf50a19ce3020b586298778c058fe7dfe95c6c6f5ffb57
+SHA512:
+  metadata.gz: 13322191a160fcc770f2d827b01ef63621676e018216204ebba6dbdc3c8ecb2b8925a9d9f15cda10bc8c8605d24bf617def43ac25e215c28319a348344da5df1
+  data.tar.gz: 798c9c83492adbf68ee0c33c8e6e50e8805df4ec7c11e5d0e428b15e84a07586ba60746e2f5f47386bb7ae06a95831b02ad388f6ecda2f9e900310e66357fbac

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andrew Davis
+
+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,66 @@
+# relinkly
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'relinkly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install relinkly
+
+## Usage
+
+If using Rails, put the following into your application.rb. If just Ruby,
+run this before trying to use the API.
+
+```ruby
+Relinkly.configure do |config|
+  config.api_key = 'YOUR_KEY_HERE'
+end
+```
+
+### Instantiate an API object.
+
+```ruby
+api = Relinkly::API.new
+```
+
+### API Requests
+
+```ruby
+api.links                           # GET /v1/links
+api.links(id)                       # GET /v1/links/:id
+api.link_count(options)             # GET /v1/links/count
+api.new_link(options)               # GET /v1/links/new
+api.shorten(destination, options)   # POST /v1/links
+api.update_link(id, options)        # POST /v1/links/:id
+api.delete(id, options)             # DELETE /v1/links/:id
+api.domains                         # GET /v1/domains
+api.domain(id)                      # GET /v1/domains/:id
+api.domain_count(options)           # GET /v1/domains/count
+api.account                         # GET /v1/account
+```
+
+### Make a new short link
+
+```ruby
+my_domain = api.domains.first
+link = api.shorten('https://google.com', domain: my_domain.to_h, title: 'Google', description: 'Google Homepage', favourite: true)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cdrrazan/relinkly.
+
+
+## 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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'relinkly'
+
+# 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/relinkly.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'relinkly/version'
+require 'relinkly/configuration'
+require 'relinkly/api'
+require 'relinkly/element'
+require 'relinkly/domain'
+require 'relinkly/creator'
+require 'relinkly/integration'
+require 'relinkly/link'
+
+module Relinkly
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.api_key
+    configuration.api_key
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end
+
+class String
+  def relinkly_underscore
+    gsub(/::/, '/')
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr('-', '_')
+      .downcase
+  end
+
+  def relinkly_camelize
+    split('_').collect(&:capitalize).join
+  end
+
+  def relinkly_lower_camelize
+    res = relinkly_camelize
+    res[0].downcase + res[1..-1]
+  end
+end

data/lib/relinkly/api.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module Relinkly
+  class RelinklyError < StandardError; end
+
+  class RateLimitExceeded < RelinklyError; end
+
+  class API
+    API_VERSION = 'v1'
+    BASE_URL = "https://api.rebrandly.com/#{API_VERSION}"
+
+    # GET /v1/links
+    def links(options = {})
+      all_links = relinkly_request(:get, 'links', options)
+      all_links.map { |link| Link.new(link) }
+    end
+
+    # GET /v1/links/:id
+    def link(id)
+      Link.new(relinkly_request(:get, "links/#{id}"))
+    end
+
+    # GET /v1/links/count
+    def link_count(_options = {})
+      relinkly_request(:get, 'links/count')['count']
+    end
+
+    # POST /v1/links
+    def shorten(destination, options = {})
+      options[:destination] = destination
+      Link.new(relinkly_request(:post, 'links', options))
+    end
+
+    # POST /v1/links/:id
+    def update_link(id, options = {})
+      Link.new(relinkly_request(:post, "links/#{id}", options))
+    end
+
+    # DELETE /v1/links/:id
+    def delete(id, options = {})
+      Link.new(relinkly_request(:delete, "links/#{id}", options))
+    end
+
+    # GET /v1/domains
+    def domains(options = {})
+      all_domains = relinkly_request(:get, 'domains', options)
+      all_domains.map { |domain| Domain.new(domain) }
+    end
+
+    # GET /v1/domains/:id
+    def domain(id)
+      Domain.new(relinkly_request(:get, "domains/#{id}"))
+    end
+
+    # GET /v1/domains/count
+    def domain_count(_options = {})
+      relinkly_request(:get, 'domains/count')['count']
+    end
+
+    # GET /v1/account
+    def account
+      Creator.new(relinkly_request(:get, 'account'))
+    end
+
+    private
+
+    def relinkly_request(method, url, options = {})
+      url = "#{BASE_URL}/#{url}"
+      # Convert all hash keys into camel case for Relinkly
+      options = Hash[options.map { |k, v| [k.to_s.relinkly_lower_camelize.to_sym, v] }]
+
+      http_attrs = { headers: headers }
+      case method
+      when :get
+        http_attrs.merge!(query: options)
+      when :post
+        http_attrs.merge!(body: options.to_json)
+      end
+
+      res = HTTParty.send(method, url, http_attrs)
+      if res.code == 200
+        JSON.parse(res.body)
+      else
+        relinkly_error = res.parsed_response
+        if relinkly_error['domain'] == 'usageLimits' && relinkly_error['reason'] == 'rateLimitExceeded'
+          raise RateLimitExceeded
+        else
+          raise RelinklyError, relinkly_error['message']
+        end
+      end
+    end
+
+    def headers
+      {
+        'Content-type' => 'application/json',
+        'apikey' => Relinkly.api_key
+      }
+    end
+  end
+end

data/lib/relinkly/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Relinkly
+  class Configuration
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = nil
+    end
+  end
+end

data/lib/relinkly/creator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Relinkly
+  class Creator < Element
+    attr_accessor :id, :full_name, :avatar_url, :username, :email, :created_at
+  end
+end

data/lib/relinkly/domain.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Relinkly
+  class Domain < Element
+    attr_accessor :id, :ref, :full_name, :top_level_domain, :level,
+                  :created_at, :updated_at, :custom_homepage, :owner_id, :type,
+                  :subdomains, :managed, :status, :https, :active
+  end
+end

data/lib/relinkly/element.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Relinkly
+  # General class to map Relinkly objects to Ruby objects
+  class Element
+    def initialize(attrs = {})
+      # Only set the attributes if the method exists, this way we can ignore deprecated attributes
+      attrs.each { |k, v| send("#{k.relinkly_underscore}=", v) if respond_to?("#{k.relinkly_underscore}=") }
+    end
+
+    def to_h
+      Hash[
+        *instance_variables.map do |variable|
+          name = variable[1..-1].to_sym # Drop the @ sign at the front
+          [name.to_sym, instance_variable_get(variable)]
+        end.flatten
+      ]
+    end
+  end
+end

data/lib/relinkly/integration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Relinkly
+  class Integration < Element
+    attr_accessor :link, :name, :link_id
+  end
+end

data/lib/relinkly/link.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Relinkly
+  class Link < Element
+    attr_accessor :id, :link_id, :title, :slashtag, :destination, :created_at,
+                  :updated_at, :status, :tags, :scripts, :forward_parameters,
+                  :clicks, :last_click_date, :last_click_at, :is_public,
+                  :short_url, :domain_id, :domain_name,
+                  :https, :favourite
+
+    # Associations
+    %i[domain creator integration].each do |association|
+      # Creates the getter methods, such as "@instance.domain"
+      attr_reader association
+
+      # Creates the setter methods, such as "@instance.domain = ..."
+      define_method("#{association}=") do |attrs|
+        attrs ||= {}
+
+        # Retrieve the class
+        klass = Relinkly.const_get(association.to_s.relinkly_camelize)
+
+        # Ex:
+        #  @domain = Domain.new(attrs)
+        instance_variable_set("@#{association}", klass.new(attrs))
+      end
+    end
+
+    alias favorite favourite
+    alias favorite= favourite=
+  end
+end

data/lib/relinkly/version.rb

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

data/relinkly.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'relinkly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "relinkly"
+  spec.version       = Relinkly::VERSION
+  spec.authors       = ["Rajan Bhattarai"]
+  spec.email         = ["hey@rajanbhattarai.com"]
+
+  spec.summary       = "A Ruby wrapper for the Rebrandly API "
+  spec.description   = "Easily create branded short links in your ruby apps using Rebrandly."
+  spec.homepage      = "https://github.com/cdrrazan/relinkly"
+  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.add_development_dependency "bundler", "~> 2.2.3"
+  spec.add_development_dependency "rake", "~> 13.0.3"
+  spec.add_development_dependency "rspec", "~> 3.10.0"
+  spec.add_dependency 'httparty', '~> 0.18.1'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: relinkly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rajan Bhattarai
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: Easily create branded short links in your ruby apps using Rebrandly.
+email:
+- hey@rajanbhattarai.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/relinkly.rb
+- lib/relinkly/api.rb
+- lib/relinkly/configuration.rb
+- lib/relinkly/creator.rb
+- lib/relinkly/domain.rb
+- lib/relinkly/element.rb
+- lib/relinkly/integration.rb
+- lib/relinkly/link.rb
+- lib/relinkly/version.rb
+- relinkly.gemspec
+homepage: https://github.com/cdrrazan/relinkly
+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: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Rebrandly API
+test_files: []