ruby_branch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a0edc2530f33ea70d9b6acfd46503d17232df8b
+  data.tar.gz: 6d740197b830aefa47f231c255d0ece0067be0f0
+SHA512:
+  metadata.gz: 6d9705fd4e50cf6eadb031601599870bcb0230b7d99197ad11fe48fe015bf01b6b41b035720a53d3a6853ab03452b76fcb46166341f0b67c6d76547a0acbfcfb
+  data.tar.gz: 75de6a1698b15625dc5b43024f7a81b5e6181438f4a5eaa951d1668a839fa5839ced9109a399728fcabb8e82476c876c1bde2300fb00012e23e96a50f6998d14

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,57 @@
+AllCops:
+  TargetRubyVersion: 2.1
+  Exclude:
+    - 'lib/ruby_branch/utils/to_query.rb'
+    - 'ruby_branch.gemspec'
+    - 'vendor/**/*'
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 12
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/AbcSize:
+  Max: 20
+
+ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/MultilineHashBraceLayout:
+  Enabled: true
+  EnforcedStyle: symmetrical
+
+Layout/MultilineArrayBraceLayout:
+  Enabled: true
+  EnforcedStyle: symmetrical
+
+Style/NumericLiterals:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+  EnforcedStyle: empty_lines
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/PredicateName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

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 accessd0@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Accessd
+
+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,60 @@
+# RubyBranch
+
+[![Build Status](https://travis-ci.org/hello-baby/ruby_branch.svg?branch=master)](https://travis-ci.org/hello-baby/ruby_branch)
+
+Ruby client for https://branch.io API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_branch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_branch
+
+## Usage
+
+Configuration:
+
+    RubyBranch.configure do |config|
+      config.api_key = 'YOUR_API_KEY'
+      config.branch_domain = 'YOUR_BRANCH_DOMAIN'
+      # for fallback in case link creation has been failed
+      config.link_to_homepage = 'https://yourdomain.com' # optional
+    end
+
+Methods:
+
+### Links
+
+    link = RubyBranch::API::Resources::Link.new
+
+    # Create link without api forcing
+    link.create_safely(analytics: {}, data: {}, settings: {})
+
+    # Create link through branch api
+    link.create(analytics: {}, data: {}, settings: {})
+
+## 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]/ruby_branch. 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 'ruby_branch'
+
+# 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/lib/ruby_branch.rb

@@ -0,0 +1,32 @@
+require 'ruby_branch/version'
+require 'ruby_branch/utils/to_query'
+require 'ruby_branch/config'
+require 'ruby_branch/errors/link_length_exceed_error'
+require 'ruby_branch/errors/api_response_error'
+require 'addressable'
+require 'faraday'
+require 'ruby_branch/api/response'
+require 'ruby_branch/api/request'
+require 'ruby_branch/api/resources/link'
+
+module RubyBranch
+  BRANCH_API_ENDPOINT = 'https://api.branch.io/'.freeze
+
+  class << self
+
+    attr_writer :config
+
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.reset
+    @config = Config.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+end

data/lib/ruby_branch/api/request.rb

@@ -0,0 +1,23 @@
+module RubyBranch
+  module API
+    class Request
+
+      def post(resource, body = '')
+        response = connection.post do |request|
+          request.url resource
+          request.headers['Content-Type'] = 'application/json'
+          request.body = body unless body.empty?
+        end
+        Response.new(response)
+      end
+
+      def connection
+        @connection ||=
+          Faraday.new(url: BRANCH_API_ENDPOINT) do |connection|
+            connection.adapter Faraday.default_adapter
+          end
+      end
+
+    end
+  end
+end

data/lib/ruby_branch/api/resources/link.rb

@@ -0,0 +1,79 @@
+module RubyBranch
+  module API
+    module Resources
+      class Link
+
+        LINK_LENGTH_LIMIT = 2000
+
+        def create_safely(analytics: {}, data: {}, settings: {})
+          build(analytics: analytics, data: data, settings: settings)
+        rescue Errors::LinkLengthExceedError
+          create(analytics: analytics, data: data, settings: settings)
+        end
+
+        def create(analytics: {}, data: {}, settings: {})
+          request_body = build_request_body(analytics, settings, data)
+          response = do_create_request(request_body)
+
+          return response.json[:url] if response.success?
+
+          error_attrs = { status: response.status, body: response.body }
+          if defined?(Bugsnag) && defined?(Rails)
+            Bugsnag.notify(Errors::ApiResponseError.new, error_attrs) if Rails.env.production?
+          end
+
+          RubyBranch.config.link_to_homepage if RubyBranch.config.link_to_homepage
+        end
+
+        def build(analytics: {}, data: {}, settings: {})
+          params = {}
+          params.merge!(prepare_analytics(analytics))
+          params.merge!(prepare_settings(settings))
+          params.merge!(data)
+
+          link = Addressable::URI.new(
+            scheme: 'https',
+            host: RubyBranch.config.branch_domain,
+            path: "/a/#{RubyBranch.config.api_key}",
+            query: ToQuery.call(params)
+          ).to_s
+          check_for_link_length_limit(link)
+          link
+        end
+
+        private
+
+        def do_create_request(request_body)
+          request = Request.new
+          request.post('v1/url', request_body.to_json)
+        end
+
+        def build_request_body(analytics, settings, data)
+          body = { branch_key: RubyBranch.config.api_key }
+          body.merge! prepare_analytics(analytics)
+          body.merge! prepare_settings(settings)
+          body.merge! prepare_data(data)
+        end
+
+        def prepare_data(data)
+          { data: data }
+        end
+
+        def prepare_analytics(analytics)
+          allowed_params = %i[channel feature campaign stage tags]
+          analytics.reject { |k, v| !allowed_params.include?(k) || v.nil? }
+        end
+
+        def prepare_settings(settings)
+          allowed_params = %i[alias type duration identity]
+          settings.reject { |k, v| !allowed_params.include?(k) || v.nil? }
+        end
+
+        def check_for_link_length_limit(link)
+          raise Errors::LinkLengthExceedError if link.size > LINK_LENGTH_LIMIT
+        end
+
+      end
+    end
+  end
+end

data/lib/ruby_branch/api/response.rb

@@ -0,0 +1,20 @@
+module RubyBranch
+  module API
+    class Response
+
+      extend Forwardable
+
+      attr_accessor :response
+      def_delegators :@response, :success?, :status, :body
+
+      def initialize(response)
+        @response = response
+      end
+
+      def json
+        JSON.parse(body, symbolize_names: true)
+      end
+
+    end
+  end
+end

data/lib/ruby_branch/config.rb

@@ -0,0 +1,7 @@
+module RubyBranch
+  class Config
+
+    attr_accessor :api_key, :branch_domain, :link_to_homepage
+
+  end
+end

data/lib/ruby_branch/errors/api_response_error.rb

@@ -0,0 +1,5 @@
+module RubyBranch
+  module Errors
+    class ApiResponseError < StandardError; end
+  end
+end

data/lib/ruby_branch/errors/link_length_exceed_error.rb

@@ -0,0 +1,5 @@
+module RubyBranch
+  module Errors
+    class LinkLengthExceedError < StandardError; end
+  end
+end

data/lib/ruby_branch/utils/to_query.rb

@@ -0,0 +1,30 @@
+require "cgi"
+
+class ToQuery
+  attr_reader :hash
+
+  def self.call(hash)
+    new.call(hash)
+  end
+
+  def call(hash)
+    @hash = hash
+    to_query(hash)
+  end
+
+  private
+
+  def to_query(hash)
+    hash.collect do |key, value|
+      if value.is_a?(Hash)
+        to_query(value)
+      else
+        to_param(key, value)
+      end
+    end.compact.sort! * "&"
+  end
+
+  def to_param(key, value)
+    "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
+  end
+end

data/lib/ruby_branch/version.rb

@@ -0,0 +1,3 @@
+module RubyBranch
+  VERSION = '0.1.0'.freeze
+end

data/ruby_branch.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_branch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_branch"
+  spec.version       = RubyBranch::VERSION
+  spec.authors       = ["Andrey Morskov"]
+  spec.email         = ["accessd0@gmail.com"]
+
+  spec.summary       = %q{Ruby client for https://branch.io API}
+  spec.description   = %q{Ruby client for https://branch.io API}
+  spec.homepage      = ""
+  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_dependency "faraday"
+  spec.add_dependency "addressable"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: ruby_branch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Morskov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for https://branch.io API
+email:
+- accessd0@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/ruby_branch.rb
+- lib/ruby_branch/api/request.rb
+- lib/ruby_branch/api/resources/link.rb
+- lib/ruby_branch/api/response.rb
+- lib/ruby_branch/config.rb
+- lib/ruby_branch/errors/api_response_error.rb
+- lib/ruby_branch/errors/link_length_exceed_error.rb
+- lib/ruby_branch/utils/to_query.rb
+- lib/ruby_branch/version.rb
+- ruby_branch.gemspec
+homepage: ''
+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.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for https://branch.io API
+test_files: []