ohby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c89596c53031985de120c5778b6b6b7303b835fb
+  data.tar.gz: 3c58c916b441cc64d88ceb0239b4b9fba9be4306
+SHA512:
+  metadata.gz: 8eed89717b0d0ae8ba8a391616b47962a59558ec7ca36dfbe41d94052d42e421b8da1869eb672409aed4009a465e7b2748feff039c4686370557c0544f9188aa
+  data.tar.gz: 15ee268a07e69fe848df49dd254485228dfe67728c0ade0bd26845dd320229019bc36e50e64b6b16ed1ec85494084bdfef994b6807fb79d3822fcde44ded66b6

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

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 janlindblom@fastmail.fm. 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 ohby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jan Lindblom
+
+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,56 @@
+# Ohby
+
+Access the "oh by" shortener (https://0x.co) from your code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ohby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ohby
+
+## Usage
+
+Use it like so:
+
+```ruby
+require 'ohby'
+
+# a public message, expiring in 10 minutes
+code = Ohby.shorten "a message", "10m"
+```
+
+or to look up a code:
+
+```ruby
+require 'ohby'
+
+message = Ohby.lookup "HVRMFJ"
+```
+
+Nothing else needed really. Read the docs for details.
+
+## 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 Bitbucket at https://bitbucket.org/janlindblom/ohby-ruby. 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,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+
+RSpec::Core::RakeTask.new(:spec)
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.stats_options = ['--list-undoc']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ohby"
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.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/bitbucket-pipelines.yml

@@ -0,0 +1,15 @@
+# This is a sample build configuration for Ruby.
+# Check our guides at https://confluence.atlassian.com/x/8r-5Mw for more examples.
+# Only use spaces to indent your .yml configuration.
+# -----
+# You can specify a custom docker image from Docker Hub as your build environment.
+image: ruby:2.3.0
+
+pipelines:
+  default:
+    - step:
+        script: # Modify the commands below to build your repository.
+          - bundler --version
+          - bundle install
+          - rake spec
+          - rake yard

data/lib/ohby.rb

@@ -0,0 +1,184 @@
+require 'net/http'
+require 'uri'
+require 'strscan'
+require 'date'
+require 'ohby/version'
+require 'ohby/too_long_error'
+require 'ohby/code_generation_error'
+require 'ohby/wrong_code_format_error'
+require 'ohby/code'
+
+# Generate "oh by" (0x) codes.
+#
+# @author Jan Lindblom <janlindblom@fastmail.fm>
+# @version 0.1.0
+module Ohby
+
+  # Generate an "oh by" code from a given payload.
+  #
+  # See #shorten for valid options of the +expiry+ parameter.
+  #
+  # @param payload [String] up to 4096 characters
+  # @param expiry [String] expiration
+  # @param is_public [Boolean] visibility
+  # @raise [TooLongError] if the payload is to long.
+  # @since 0.1.0
+  def self.code(payload=nil,expiry=0,is_public=true)
+    shorten(payload,expiry,is_public,false)
+  end
+
+  # Generate an "oh by" redirect from a given payload that is a valid URI.
+  #
+  # See #shorten for valid options of the +expiry+ parameter.
+  #
+  # @param payload [String] up to 4096 characters
+  # @param expiry [String] expiration
+  # @param is_public [Boolean] visibility
+  # @raise [TooLongError] if the payload is to long.
+  # @since 0.1.0
+  def self.redirect(payload=nil,expiry=0,is_public=true)
+    shorten(payload,expiry,is_public,true)
+  end
+
+  # Generate an "oh by" code or redirect from a given payload.
+  #
+  # Valid options for the +expiry+ parameter:
+  # - +0+ - never expire
+  # - +10m+ - 10 Minutes
+  # - +1h+ - 1 Hour
+  # - +1D+ - 1 Day
+  # - +1W+ - 1 Week
+  # - +1M+ - 1 Month
+  # - +1Y+ - 1 Year
+  #
+  # @param payload [String] up to 4096 characters
+  # @param expiry [String] expiration
+  # @param is_public [Boolean] visibility
+  # @raise [TooLongError] if the payload is to long.
+  # @raise [CodeGenerationError] if the payload couldn't be shortened.
+  # @since 0.1.0
+  def self.shorten(payload=nil,expiry=0,is_public=true,redirect=false)
+    base_uri = "https://0x.co/shorten.html"
+    is_url = redirect ? true : false
+
+    # Check if the message is a URL to decide whether or not to set redirect.
+    is_url = check_if_message_is_url(payload)
+
+    request = {
+        "content" => payload,
+        "expiry" => expiry.to_s,
+        "public" => is_public ? "1" : "0"
+    }
+
+    unless payload.nil?
+      raise TooLongError.new(
+        "Payload too long, exceds 4096 characters.") if payload.size > 4096
+
+      if redirect == true
+        request["redirect"] = "1"
+      elsif redirect != false && is_url
+        request["redirect"] = "1"
+      elsif redirect == false && is_url
+        request["redirect"] = "0"
+      end
+
+      # Do a POST request and get the body if everything worked out.
+      post = Net::HTTP.post_form(URI(base_uri), request)
+      unless post.response.is_a? Net::HTTPOK
+        raise CodeGenerationError.new("Unable to perform request.") 
+      end
+      result = post.body
+      # Get the <body> and set up a scanner on it
+      scanner = StringScanner.new(
+          result.gsub(/\n/,'').match(/<body>(.*)<\/body>/)[1])
+      # Find the part with the code
+      scanner.skip_until /0 x /
+      # Get the code (asciinumeral) from the scanner
+      code=scanner.scan /[A-z0-9]+/
+      code
+    end
+  end
+
+  # Look up an existing 0x-code to see what it contains.
+  #
+  # @param code [String] the code to look up
+  def self.lookup(code=nil)
+    base_uri = "https://0x.co/"
+    require 'rexml/document'
+    raise WrongCodeFormatError.new(
+      "Bad code format, should be a simple String.") unless code.is_a? String
+    raise WrongCodeFormatError.new("Bad code, cannot be nil.") if code.nil?
+
+    # Strip any "0x" from the supplied string.
+    payload = code.start_with?("0x") ? code.slice(2..-1) : code
+
+    # Perform lookup by posting to form, this way we get an empty xml back if
+    # the code is not found.
+    response = Net::HTTP.get(URI(base_uri + payload))
+
+    code_section = response.gsub(/\n/,'').match(
+      /<script.*id=\"code\".*application\/xml.*>.*<\/script>/)[0]
+
+    scanner = StringScanner.new(code_section)
+    end_tag = /\<\/script>/
+    scanner.skip(/<script.*\"application\/xml\">/)
+    response_xml = scanner.scan_until(end_tag)
+    response_xml.gsub!(end_tag,'').strip!
+    
+    document = REXML::Document.new "<ohby>" + response_xml + "</ohby>"
+    response_hash = {}
+    
+    code_object = Ohby::Code.new
+
+    document.root.elements.each do |element|
+      setter = element.name.to_s + "="
+      processed = process_text(element)
+      
+      case element.name
+      when "code", "message", "hash"
+        code_object.send(setter, processed)
+      when "date"
+        code_object.send(setter,
+                         process_string_into_datetime(processed))
+      when "expires"
+        code_object.send(setter,
+                         process_text(element) == "" ? "" :
+                         process_string_into_datetime(processed))
+      when "visibility", "redirect"
+        code_object.send(setter,
+                         process_string_into_boolean(processed))
+      end
+    end
+    code_object
+  end
+
+  private
+
+  def self.process_text(element)
+    element.has_text? ? element.get_text.to_s : ""
+  end
+
+  # Appends "PST" to all datetime strings since 0x.co timestamps are given
+  # in PST (not really documented anywhere though)
+  def self.process_string_into_datetime(text)
+    DateTime.parse(text + " PST")
+  end
+
+  def self.process_string_into_boolean(text)
+    return true if text == "1"
+    false
+  end
+
+  def self.check_if_message_is_url(text)
+    is_url = false
+    begin
+      uri = URI.parse(text)
+      if uri.is_a? URI::HTTP or uri.is_a? URI::HTTPS
+        is_url = true
+      end
+    rescue URI::InvalidURIError
+    end
+    is_url
+  end
+
+end

data/lib/ohby/code.rb

@@ -0,0 +1,24 @@
+module Ohby
+  # Object representation of an 0x-code.
+  #
+  # @author Jan Lindblom <janlindblom@fastmail.fm>
+  # @version 0.1.0
+  # @since 0.1.0
+  class Code < Object
+    # The code itself
+    attr_accessor :code
+    # The message, or contents, this code represents
+    attr_accessor :message
+    # The date this 0x-code was created
+    attr_accessor :date
+    # The expiry of this code
+    attr_accessor :expires
+    # The visibility of this code
+    attr_accessor :visibility
+    # The Sha256 hash of this code
+    attr_accessor :hash
+    # Redirect flag on this code
+    attr_accessor :redirect
+
+  end
+end

data/lib/ohby/code_generation_error.rb

@@ -0,0 +1,9 @@
+module Ohby
+  # An error during oh by code generation.
+  # 
+  # @author Jan Lindblom <janlindblom@fastmail.fm>
+  # @version 0.1.0
+  # @since 0.1.0
+  class CodeGenerationError < StandardError
+  end
+end

data/lib/ohby/too_long_error.rb

@@ -0,0 +1,9 @@
+module Ohby
+    # An error indicating the input is too long, more than 4096 characters.
+    #
+    # @author Jan Lindblom <janlindblom@fastmail.fm>
+    # @version 0.1.0
+    # @since 0.1.0
+    class TooLongError < StandardError
+    end
+end

data/lib/ohby/version.rb

@@ -0,0 +1,4 @@
+module Ohby
+  # Current version.
+  VERSION = "0.1.0"
+end

data/lib/ohby/wrong_code_format_error.rb

@@ -0,0 +1,9 @@
+module Ohby
+  # An error indicating the input is malformed in some way.
+  #
+  # @author Jan Lindblom <janlindblom@fastmail.fm>
+  # @version 0.1.0
+  # @since 0.1.0
+  class WrongCodeFormatError < StandardError
+  end
+end

data/ohby.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ohby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ohby"
+  spec.version       = Ohby::VERSION
+  spec.authors       = ["Jan Lindblom"]
+  spec.email         = ["janlindblom@fastmail.fm"]
+
+  spec.summary       = %q{Generate oh by codes.}
+  spec.homepage      = "https://bitbucket.org/janlindblom/ohby"
+  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.metadata["yard.run"] = "yri"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: ohby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Lindblom
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-08 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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email:
+- janlindblom@fastmail.fm
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bitbucket-pipelines.yml
+- lib/ohby.rb
+- lib/ohby/code.rb
+- lib/ohby/code_generation_error.rb
+- lib/ohby/too_long_error.rb
+- lib/ohby/version.rb
+- lib/ohby/wrong_code_format_error.rb
+- ohby.gemspec
+homepage: https://bitbucket.org/janlindblom/ohby
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+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.2
+signing_key: 
+specification_version: 4
+summary: Generate oh by codes.
+test_files: []