onename 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18c3c0ad91f44ea48651d449bab5f6d5e6b4bca8
+  data.tar.gz: 34f62ee837084a8767b37f79a90c8bb2d23f4bfb
+SHA512:
+  metadata.gz: d9d84369ee46c65a399aecbd3992245a95d38ed830779f4e4d678e86d0ddfa1e2929c29a0a5f93f15fea92124e12bd067e986aa07f03b83aa52e4182ac3e2f26
+  data.tar.gz: b9ded855f931ce6eb4eead10d78f8b36319a09912fcbf9e5ae21f247e4e6083f41cde5007fd3f795a4b796b9af57a7ee60f3f8ce143b9c0d89d9e3ca4bfdaeec

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Appartisan Limited
+
+MIT License
+
+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,35 @@
+# Onename
+
+A ruby library for the OneName distributed identity system
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'onename'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install onename
+
+## Usage
+
+ ```
+ require "onename"
+ user = Onename.get("larry")
+ 
+ larrys_bitcoin_address = user.bitcoin_address
+ larrys_website = user.website
+ ```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/onename/version.rb

@@ -0,0 +1,3 @@
+module Onename
+  VERSION = "0.1"
+end

data/lib/onename.rb

@@ -0,0 +1,155 @@
+require "onename/version"
+require 'net/http'
+require 'json'
+
+
+##
+# A toolkit for the OneName distributed identity system
+module Onename
+  DEFAULT_ENDPOINT = "https://www.onename.io" 
+  SCHEMA_VERSION = "0.2"
+  USERAGENT = "onename-ruby #{VERSION}"
+  
+  # https://github.com/onenameio/onename#usernames 
+  ONENAME_REGEX = /^[a-z0-9_]{1,60}$/
+  
+  @@endpoint = nil
+
+  ##
+  # Current endpoint used by the library
+  def self.endpoint
+    if @@endpoint.nil?
+      return DEFAULT_ENDPOINT
+    else
+      return @@endpoint
+    end
+  end
+  
+  ##
+  # Set endpoint to +url+
+  # if +url+ is +nil+, +DEFAULT_ENDPOINT+ is used as the endpoint
+  def self.endpoint=(url)
+    @@endpoint = url
+  end
+
+  ##
+  # Check if the given +onename+ is in proper format
+  # Does not downcase input
+  def self.valid?(onename)
+    Onename::ONENAME_REGEX.match(onename).nil? ? false : true
+  end
+
+  ##
+  # Retrieve JSON data stored in OneName record
+  def self.get_json(onename) 
+    
+    uri = URI(self.endpoint + "/#{onename.downcase}.json")
+    https = Net::HTTP.new(uri.host,uri.port)
+    https.use_ssl = true
+    req = Net::HTTP::Get.new(uri.path, {'User-Agent' => USERAGENT})
+    res = https.request(req)
+    case res.code
+      when 404 then raise NameError.new("User with OneName \"#{onename}\" does not exist")
+      when res.code != 200 then
+        error = JSON.parse(res.body)
+        raise RuntimeError.new("OneName endpoint returned error: #{error["error"]}")
+    end  
+    json = JSON.parse(res.body)
+    
+  end
+  
+  ##
+  # Return a +User+ representing the given onename
+  def self.get(onename)
+    User.from_json(self.get_json(onename),onename)
+  end
+  
+  
+  class User
+    def self.from_json(json,onename)
+      User.new(json,onename)
+    end
+    
+    attr_reader :onename
+    attr_reader :name_formatted
+    attr_reader :avatar_url
+    attr_reader :cover_url
+    attr_reader :location_formatted
+    attr_reader :website
+    attr_reader :bio
+    attr_reader :github_username
+    attr_reader :facebook_username
+    attr_reader :twitter_username
+    attr_reader :linkedin_username
+    attr_reader :bitcoin_address
+    attr_reader :bitmessage_address
+    attr_reader :bitcoinotc_username
+    attr_reader :pgp_fingerprint
+    attr_reader :pgp_url
+    attr_reader :orgs
+    attr_reader :schema_version
+    
+       
+    def initialize(json,onename)
+      @onename = onename
+      @name_formatted = json["name"]["formatted"] if json["name"]
+      @avatar_url = json["avatar"]["url"] if json["avatar"]
+      @cover_url = json["cover"]["url"] if json["cover"]
+      @location_formatted = json["location"]["formatted"] if json["location"]
+      @website = json["website"]
+      @bio = json["bio"]
+      @github_username = json["github"]["username"] if json["github"]
+      @facebook_username = json["facebook"]["username"] if json["facebook"]
+      @twitter_username = json["twitter"]["username"] if json["twitter"]
+      @linkedin_username = json["linkedin"]["username"] if json["linkedin"]
+      @bitcoin_address = json["bitcoin"]["address"] if json["bitcoin"]
+      @bitmessage_address = json["bitmessage"]["username"] if json["bitmessage"]
+      @bitcoinotc_username = json["bitcoinotc"]["username"] if json["bitcoinotc"]
+      @pgp_fingerprint = json["pgp"]["fingerprint"] if json["pgp"]
+      @pgp_url = json["pgp"]["url"] if json["url"]
+      @schema_version = json["v"]
+      @orgs = parse_orgs(json["orgs"])
+    end
+    
+    protected 
+    
+    def parse_orgs(orgs_json) 
+      orgs = Array.new
+      if orgs_json
+        for org_json in orgs_json
+          orgs << Org.new(org_json)    
+        end
+      end
+      orgs
+    end
+  
+  end
+  
+  class Org
+    def self.from_json(json)
+      Org.new(json)
+    end
+    
+    attr_reader :url
+    attr_reader :relationship
+    attr_reader :name
+    
+    
+    def initialize(json)
+      @url = json["url"] if json["url"]
+      @relationship = json["relationship"] if json["relationship"]
+      @name = json["name"] if json["name"]
+    end
+    
+    
+  end
+  
+  protected
+  
+  def self.check_schema_version(json_result)
+    if json_result["v"] != SCHEMA_VERSION
+      warn "Onename gem only supports OneName schema version #{SCHEMA_VERSION}"
+    end
+  end
+
+end

data/onename.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onename/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "onename"
+  spec.version       = Onename::VERSION
+  spec.authors       = ["Larry Salibra"]
+  spec.email         = ["larry@pay4bugs.com"]
+  spec.description   = "Ruby library for the OneName distributed identity system"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/pay4bugs/onename-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+end

data/spec/fixtures/cassettes/onename.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.onename.io/larry.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - onename-ruby 0.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Sun, 06 Apr 2014 14:00:02 GMT
+      Server:
+      - gunicorn/18.0
+      Strict-Transport-Security:
+      - max-age=31536000
+      Content-Length:
+      - '909'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "{\n  \"bitcoin\": {\n    \"address\": \"143xFrxppUD9oQE7mGvQFe23h814YorMBs\"\n
+        \ }, \n  \"avatar\": {\n    \"url\": \"http://www.larrysalibra.com/images/custom/larry.png\"\n
+        \ }, \n  \"facebook\": {\n    \"username\": \"larry.salibra\"\n  }, \n  \"cover\":
+        {\n    \"url\": \"http://www.larrysalibra.com/images/custom/home_bg.png\"\n
+        \ }, \n  \"instagram\": {\n    \"username\": \"larrysalibra\"\n  }, \n  \"location\":
+        {\n    \"formatted\": \"Hong Kong\"\n  }, \n  \"linkedin\": {\n    \"url\":
+        \"http://www.linkedin.com/in/larrysalibra\"\n  }, \n  \"github\": {\n    \"username\":
+        \"larrysalibra\"\n  }, \n  \"v\": \"0.2\", \n  \"twitter\": {\n    \"username\":
+        \"larrysalibra\"\n  }, \n  \"bio\": \"Founder/CEO Pay4Bugs\", \n  \"website\":
+        \"http://www.larrysalibra.com\", \n  \"angellist\": {\n    \"username\": \"larry-salibra\"\n
+        \ }, \n  \"pgp\": {\n    \"url\": \"https://keybase.io/larry/key.asc\", \n
+        \   \"fingerprint\": \"B516CB7A08819697B25E4694DE3B5425164C4849\"\n  }, \n
+        \ \"name\": {\n    \"formatted\": \"Larry Salibra\"\n  }\n}"
+    http_version: 
+  recorded_at: Sun, 06 Apr 2014 14:00:02 GMT
+recorded_with: VCR 2.9.0

data/spec/lib/onename_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Onename, :vcr => { :cassette_name => "onename" }  do
+ 
+  
+  it "should have a default endpoint" do
+    Onename.endpoint.should == "https://www.onename.io"
+  end
+  
+  it "should allow setting a different endpoint and returning to default" do
+    Onename.endpoint = "https://www.example.com"
+    Onename.endpoint.should == "https://www.example.com"
+    Onename.endpoint = nil
+    Onename.endpoint.should == "https://www.onename.io"
+  end
+  
+  it "should retrieve onename user" do 
+    user = Onename.get("larry")
+    user.is_a?(Onename::User).should == true
+  end
+    
+    context "we've retrieved a onename user" do 
+      before :each do 
+        @user = Onename.get("larry")
+      end
+      
+      it "should have a onename" do 
+        @user.onename.should == "larry"
+      end
+      
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'onename'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+
+RSpec.configure do |config|
+ 
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: onename
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Larry Salibra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: vcr
+  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 library for the OneName distributed identity system
+email:
+- larry@pay4bugs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/onename.rb
+- lib/onename/version.rb
+- onename.gemspec
+- spec/fixtures/cassettes/onename.yml
+- spec/lib/onename_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pay4bugs/onename-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.1.8
+signing_key: 
+specification_version: 4
+summary: Ruby library for the OneName distributed identity system
+test_files:
+- spec/fixtures/cassettes/onename.yml
+- spec/lib/onename_spec.rb
+- spec/spec_helper.rb