openname 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 230cf6eb56f09632379dd5c096ca5c84b9d651d0
-  data.tar.gz: c7a8d3bd21dbcf425d9d484f2b1ee35f51ef3835
+  metadata.gz: 4433104db84be7239b1fa5927708e50f6096954e
+  data.tar.gz: 7969f727f1dfd5919187a06c3e97f445b0bddb8a
 SHA512:
-  metadata.gz: 6a56ecf26935db8e94ed934cf6ba97e4a28f83cf67f5137110420b09eb7697375e8c8e761d4af137efc6948901bdda4e91f00fd7fcf3a4d289630e44bf7efd61
-  data.tar.gz: afc53c53d14cb218c712bbf37ecada2ed94cadb7684db085506f2d1ebeaef92457175413e136762526667c8a47f4af9d45a8bbbe3f2e87dd9101b313c12b9818
+  metadata.gz: 674f7b7ca5b221c66d954b22fd0ab3e22d72d84f8ab6119ba24b24bba63b146d7c13b74b137cfc257043e35714522f5f721fef09c122b2c424deaf666ffd2aa4
+  data.tar.gz: cde1a9cb0310e80137cf1baa5734589390fb52191911bce282ef3f86ecce89f1a64630f419db4ed98703a2a5f222686c843bd88676a401fcb835397f0d76e6e6

data/lib/openname.rb

@@ -7,217 +7,246 @@ require 'bitcoin'
 ##
 # A toolkit for the Openname distributed identity & naming system
 module Openname
-  DEFAULT_ENDPOINT = "https://openname.nametiles.co/v2/"
-  SCHEMA_VERSION = "0.2"
-  USERAGENT = "openname-ruby #{VERSION}"
+    DEFAULT_ENDPOINT = "https://api.nametiles.co/v1/users/"
+    SCHEMA_VERSION = "0.2"
+    USERAGENT = "openname-ruby #{VERSION}"
 
-  # https://github.com/openname/openname-specifications#usernames
-  OPENNAME_REGEX = /^[a-z0-9_]{1,60}$/
+    # https://github.com/openname/openname-specifications#usernames
+    OPENNAME_REGEX = /^[a-z0-9_]{1,60}$/
 
-  @@endpoint = nil
+    @@endpoint = nil
 
-  @@suffix = ".json"
+    @@suffix = ""
 
-  @@username = nil
-  @@password = nil
+    @@profile_only = false
 
-  ##
-  # Current endpoint used by the library
-  def self.endpoint
-    if @@endpoint.nil?
-      return DEFAULT_ENDPOINT
-    else
-      return @@endpoint
+    @@username = nil
+    @@password = nil
+
+    ##
+    # Current endpoint used by the library
+    def self.endpoint
+        if @@endpoint.nil?
+            return DEFAULT_ENDPOINT
+        else
+            return @@endpoint
+        end
     end
-  end
-
-  ##
-  # Send basic authentication
-  #
-  def self.auth(username, password)
-    @@username = username
-    @@password = password
-  end
-
-  ##
-  # Set suffix appended to openname to +suffix+
-  # if +suffix+ is +nil+, no suffix will be appended
-  def self.suffix=(suffix)
-    @@suffix = suffix
-  end
-
-  ##
-  # Suffix appended to openname on each endpoint request
-  def self.suffix
-    if @@suffix.nil?
-      return ""
-    else
-      return @@suffix
+
+    ##
+    # Send basic authentication
+    # Openname.auth(nil,nil) disables basic auth
+    # Disabled by default
+    #
+    def self.auth(username, password)
+        @@username = username
+        @@password = password
     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 +openname+ is in proper format
-  # Does not downcase input
-  def self.valid?(openname)
-    Openname::OPENNAME_REGEX.match(openname).nil? ? false : true
-  end
-
-  ##
-  # Retrieve JSON data stored in Openname record
-  def self.get_json(openname)
-    raise ArgumentError.new("#{openname} is not a valid Openname") if !self.valid?(openname)
-    uri = URI(self.endpoint + "/#{openname.downcase}#{self.suffix}")
-    http = Net::HTTP.new(uri.host,uri.port)
-    http.use_ssl = uri.scheme == "https" ? true : false
-    req = Net::HTTP::Get.new(uri.path, {'User-Agent' => USERAGENT})
-    req.basic_auth(@@username, @@password) if @@username && @@password
-    res = http.request(req)
-    case res.code.to_s
-      when "404" then raise NameError.new("Openname \"#{openname}\" does not exist")
-      when "200" then
-         json_body = JSON.parse(res.body)
-         if(json_body["status"] && json_body["status"] == "reserved")
-           NameError.new("Openname \"#{openname}\" does not exist. It is reserved.")
-         else
-
-            # Current ONS resolver always returns 200
-            # so we need to manually detect names that don't exist
-            if (json_body["error"])
-                raise NameError.new("Openname \"#{openname}\" does not exist")
-            end
 
-            # Current ONS resolver wraps profile
-            # so as to also return proof verification
-            # results. openname-ruby ignores verifications
-            if (json_body["profile"])
-                 json_body["profile"]
-            else
-                json_body
-            end
-         end
-	  else
-        error = JSON.parse(res.body)
-        raise RuntimeError.new("Openname endpoint returned error: #{error["error"]}")
+    ##
+    # Profile only
+    # if +profile_only+ is true, Openname profile will not be wrapped in
+    # { "profile": {} }
+    #
+    def self.profile_only(profile_only)
+        @@profile_only = profile_only
     end
 
-  end
-
-  ##
-  # Return a +User+ representing the given openname
-  def self.get(openname)
-    User.from_json(self.get_json(openname),openname)
-  end
-
-  ##
-  # Takes either a bitcoin address or a openname
-  # Returns the bitcoin address associated with the openname or passes through address provided
-  def self.get_bitcoin_address(openname_or_address)
-	 return openname_or_address if Bitcoin.valid_address?(openname_or_address)
-	 raise ArgumentError.new("#{openname_or_address} is not a valid Openname or Bitcoin address") if !self.valid?(openname_or_address)
-	 user = get(openname_or_address)
-	 raise NameError.new("Openname user #{openname_or_address} does not have a Bitcoin address") if !Bitcoin.valid_address?(user.bitcoin_address)
-	 return user.bitcoin_address
-  end
-
-  class User
-    def self.from_json(json,openname)
-      User.new(json,openname)
+    def self.profile_only?
+        @@profile_only
     end
 
-    attr_reader :openname
-    attr_reader :name_formatted
-    attr_reader :avatar_url
-    attr_reader :cover_url
-    attr_reader :location_formatted
-    attr_reader :website
-    attr_reader :bio
-    attr_reader :angellist_username
-    attr_reader :github_username
-    attr_reader :facebook_username
-    attr_reader :twitter_username
-    attr_reader :instagram_username
-    attr_reader :linkedin_url
-    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,openname)
-      @openname = openname
-      @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"]
-      @angellist_username = json["angellist"]["username"] if json["angellist"]
-      @github_username = json["github"]["username"] if json["github"]
-      @facebook_username = json["facebook"]["username"] if json["facebook"]
-      @twitter_username = json["twitter"]["username"] if json["twitter"]
-      @instagram_username = json["instagram"]["username"] if json["instagram"]
-      @linkedin_url = json["linkedin"]["url"] if json["linkedin"]
-      @bitcoin_address = json["bitcoin"]["address"] if json["bitcoin"]
-      @bitmessage_address = json["bitmessage"]["address"] 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["pgp"]
-      @schema_version = json["v"]
-      @orgs = parse_orgs(json["orgs"])
+
+    ##
+    # Set suffix appended to openname to +suffix+
+    # if +suffix+ is +nil+, no suffix will be appended
+    def self.suffix=(suffix)
+        @@suffix = suffix
     end
 
-    protected
+    ##
+    # Suffix appended to openname on each endpoint request
+    def self.suffix
+        if @@suffix.nil?
+            return ""
+        else
+            return @@suffix
+        end
+    end
 
-    def parse_orgs(orgs_json)
-      orgs = Array.new
-      if orgs_json
-        for org_json in orgs_json
-          orgs << Org.new(org_json)
+    ##
+    # 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 +openname+ is in proper format
+    # Does not downcase input
+    def self.valid?(openname)
+        Openname::OPENNAME_REGEX.match(openname).nil? ? false : true
+    end
+
+    ##
+    # Retrieve JSON data stored in Openname record
+    def self.get_json(openname)
+        raise ArgumentError.new("#{openname} is not a valid Openname") if !self.valid?(openname)
+        uri = URI(self.endpoint + "/#{openname.downcase}#{self.suffix}")
+        http = Net::HTTP.new(uri.host,uri.port)
+        http.use_ssl = uri.scheme == "https" ? true : false
+        req = Net::HTTP::Get.new(uri.path, {'User-Agent' => USERAGENT})
+        req.basic_auth(@@username, @@password) if @@username && @@password
+        res = http.request(req)
+        case res.code.to_s
+        when "404" then raise NameError.new("Openname \"#{openname}\" does not exist")
+        when "200" then
+            json_body = JSON.parse(res.body)
+            if(json_body["status"] && json_body["status"] == "reserved")
+                NameError.new("Openname \"#{openname}\" does not exist. It is reserved.")
+            else
+
+                # Current ONS resolver always returns 200
+                # so we need to manually detect names that don't exist
+                if (json_body["error"])
+                    raise NameError.new("Openname \"#{openname}\" does not exist")
+                end
+
+                # Current ONS resolver wraps profile
+                # so as to also return proof verification
+                # results. openname-ruby ignores verifications
+                if (profile_only? && json_body["profile"])
+                    json_body["profile"]
+                else
+                    json_body
+                end
+            end
+        else
+            error = JSON.parse(res.body)
+            raise RuntimeError.new("Openname endpoint returned error: #{error["error"]}")
         end
-      end
-      orgs
+
     end
 
-  end
+    ##
+    # Return a +User+ representing the given openname
+    def self.get(openname)
+        User.from_json(self.get_json(openname),openname)
+    end
 
-  class Org
-    def self.from_json(json)
-      Org.new(json)
+    ##
+    # Takes either a bitcoin address or a openname
+    # Returns the bitcoin address associated with the openname or passes through address provided
+    def self.get_bitcoin_address(openname_or_address)
+        return openname_or_address if Bitcoin.valid_address?(openname_or_address)
+        raise ArgumentError.new("#{openname_or_address} is not a valid Openname or Bitcoin address") if !self.valid?(openname_or_address)
+        user = get(openname_or_address)
+        raise NameError.new("Openname user #{openname_or_address} does not have a Bitcoin address") if !Bitcoin.valid_address?(user.bitcoin_address)
+        return user.bitcoin_address
     end
 
-    attr_reader :url
-    attr_reader :relationship
-    attr_reader :name
+    class User
+        def self.from_json(json,openname)
+            User.new(json,openname)
+        end
+
+        attr_reader :username
+        attr_reader :name_formatted
+        attr_reader :avatar_url
+        attr_reader :cover_url
+        attr_reader :location_formatted
+        attr_reader :website
+        attr_reader :bio
+        attr_reader :angellist_username
+        attr_reader :github_username
+        attr_reader :facebook_username
+        attr_reader :twitter_username
+        attr_reader :instagram_username
+        attr_reader :linkedin_url
+        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,username)
+            if(json["profile"])
+                json = json["profile"]
+            end
 
+            @username = username
+            @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"]
+            @angellist_username = json["angellist"]["username"] if json["angellist"]
+            @github_username = json["github"]["username"] if json["github"]
+            @facebook_username = json["facebook"]["username"] if json["facebook"]
+            @twitter_username = json["twitter"]["username"] if json["twitter"]
+            @instagram_username = json["instagram"]["username"] if json["instagram"]
+            @linkedin_url = json["linkedin"]["url"] if json["linkedin"]
+            @bitcoin_address = json["bitcoin"]["address"] if json["bitcoin"]
+            @bitmessage_address = json["bitmessage"]["address"] 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["pgp"]
+            @schema_version = json["v"]
+            @orgs = parse_orgs(json["orgs"])
+
+
+        end
+
+        def openname
+            warn "[DEPRECATION] `openname` is deprecated.  Please use `username` instead."
+            username
+        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
 
-    def initialize(json)
-      @url = json["url"] if json["url"]
-      @relationship = json["relationship"] if json["relationship"]
-      @name = json["name"] if json["name"]
     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
+    end
 
-  def self.check_schema_version(json_result)
-    if json_result["v"] != SCHEMA_VERSION
-      warn "Openname gem only supports Openname schema version #{SCHEMA_VERSION}"
+    protected
+
+    def self.check_schema_version(json_result)
+        if json_result["v"] != SCHEMA_VERSION
+            warn "Openname gem only supports Openname schema version #{SCHEMA_VERSION}"
+        end
     end
-  end
 
 end

data/lib/openname/version.rb

@@ -1,3 +1,3 @@
 module Openname
-  VERSION = "0.4.9"
+    VERSION = "0.4.10"
 end

data/spec/lib/onename_spec.rb

@@ -12,7 +12,7 @@ describe Openname, :vcr => { :cassette_name => "openname", :record => :new_episo
 		Openname.endpoint = "https://www.example.com"
 		Openname.endpoint.should == "https://www.example.com"
 	    Openname.endpoint = nil
-	    Openname.endpoint.should == "https://openname.nametiles.co/v2/"
+	    Openname.endpoint.should == "https://api.nametiles.co/v1/users"
 	  end
 
 	it "should retrieve openname user" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openname
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.4.10
 platform: ruby
 authors:
 - Larry Salibra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler