devtunnel 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74585f8cbe97dd0296d319a555829ac09287cfa4
-  data.tar.gz: 20c128695ef4246c22a52e28d3c659070efe0160
+  metadata.gz: 8310b1def1d120f7914349a6b78a38b2f4eac9ad
+  data.tar.gz: 08e4be19e03a9eb02153934db0b1c420a852ff95
 SHA512:
-  metadata.gz: c7d24793ab6470191918c0c4921f39568775d215023f75b0966ec74f01237231cc5f9abe3af66b5c1f33f9d43d8f8cbeaf498a98bbe476dec6b240c495f47c03
-  data.tar.gz: 47885134987032dd82307aea3ac1a2eb207c28cc3b0759fb6eef5d2260096659022d93f4150690ebb3760351938023eea5da3396c38c87d7f3e939ea5683690b
+  metadata.gz: 80ce31bc5c9e1c84ebfeac48736531cc17230191e8ad57ef3032983337421efdcb7ea6a1e44e233e01837c8e26928e6bd326efd6cfd9e299f14f568d6cdc6458
+  data.tar.gz: 9ac6cec42c64010789253ff734efc346dade4adfe47017b6d6fd5ceae53210df37e2c23166877f15a6d9658cd3d0a6ee61f1e90c311a884ae74352c49562b220

data/bin/devtunnel

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+#
+require 'devtunnel'
+require 'commander/import'
+require 'io/console'
+
+program :version, '0.0.1'
+program :description, 'Command-line interface for https://devtunnel.madebymarket.com.'
+
+default_command :upload
+
+command :signup do |c|
+  c.syntax = 'devtunnel signup, [options]'
+  c.summary = ''
+  c.description = ''
+  c.example 'description', 'command example'
+  c.action do |args, options|
+		puts "Register for a free devtunnel account using your email address and a password."
+		email = ask "email address: " 
+		account = Devtunnel::Account.signup email
+		if account.success?
+			account.write_creds
+			puts "Account created, saving your credentials to #{File.expand_path("~/.devtunnel_auth")}."
+			puts "Once you have confirmed your account, you can run 'devtunnel forward --port 8080' to forward port 8080 through your devtunnel."
+		else
+			puts account.errors
+		end
+  end
+end
+
+command :login do |c|
+  c.syntax = 'devtunnel login, [options]'
+  c.summary = ''
+  c.description = ''
+  c.example 'description', 'command example'
+  c.action do |args, options|
+		email = ask "Enter your email address: " 
+		pw = password "Enter your devtunnel password (will not be shown):"
+		account = Devtunnel::Account.login email, pw
+		if account.success?
+			account.write_creds
+			puts "Logged in, saving your credentials to #{File.expand_path("~/.devtunnel_auth")}"
+		else
+			puts account.errors
+		end
+  end
+end
+
+command :forward do |c|
+  c.syntax = 'devtunnel upload, [options]'
+  c.summary = ''
+  c.description = ''
+  c.example 'description', 'command example'
+  c.option '--file STRING', String, 'File to upload'
+  c.action do |args, options|
+		account = Devtunnel::Account.from_creds
+		unless options.file
+			puts "Syntax: devtunnel --file /your/file.pdf"
+			exit 0
+		end
+		Devtunnel.api_key = account.api_key
+	
+		puts "forwarding port. Other people can connect at: xyz"		
+
+  end
+end
+
+command :logout do |c|
+  c.syntax = 'devtunnel logout [options]'
+  c.summary = ''
+  c.description = ''
+  c.example 'description', 'command example'
+  c.option '--some-switch', 'Some switch that does something'
+  c.action do |args, options|
+		Devtunnel::Account.logout 
+		puts "You've been logged out successfully."
+  end
+end
+

data/devtunnel.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| puts f; File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 

data/lib/devtunnel.rb

@@ -1,5 +1,25 @@
-require "devtunnel/version"
+require_relative "devtunnel/version"
+require_relative "devtunnel/api"
+require_relative "devtunnel/api_response"
+require_relative "devtunnel/entity"
+require_relative "devtunnel/api_error"
+require "rest_client"
+require "json"
 
 module Devtunnel
-  # Your code goes here...
+	@api_key = nil
+	@api_url = "https://devtunnel.madebymarket.com/api/v1"
+
+	def self.api_key=(api_key)
+		@api_key = api_key
+	end
+	def self.api_key
+		@api_key
+	end
+	def self.api_url=(api_url)
+		@api_url = api_url
+	end
+	def self.api_url
+		@api_url
+	end
 end

data/lib/devtunnel/account.rb

@@ -0,0 +1,38 @@
+require_relative "api_model"
+
+module Devtunnel
+  class Account
+    include ApiModel
+    attr_accessor :api_key, :email
+
+    def self.login(email, password)
+      params = {:basic_username => email, :basic_password => password}
+      Devtunnel::Api.request :post, "/login", params
+    end
+
+    def self.signup(email)
+      params = {:email => email}
+      Devtunnel::Api.request :post, "/signup", params
+    end
+
+		def write_creds
+			File.open(File.expand_path("~/.devtunnel_auth"), "w") do |f|
+				f.write({api_key: api_key, email: email}.to_json)
+			end
+		end
+
+		def self.from_creds
+			fn = File.expand_path("~/.devtunnel_auth")
+			raise Exception.new("Please log in first") unless File.exist? fn
+			File.open(fn, "r") do |f|
+				hash = JSON.parse f.read
+				self.new hash
+			end
+		end
+	
+		def self.logout
+			fn = File.expand_path("~/.devtunnel_auth")
+			File.unlink(fn) if File.exist? fn
+		end
+  end
+end

data/lib/devtunnel/api.rb

@@ -0,0 +1,72 @@
+require "rest_client"
+
+module Devtunnel
+	class Api
+		@@api_jack = nil
+
+		def self.jack=(double)
+	 		@@api_jack = double
+		end
+		def self.jack
+			@@api_jack
+		end
+
+		def self.request method, url, params = {}, api_key = :account_api_key
+			begin
+				basic_username = 	Devtunnel.api_key
+
+				if params[:basic_username]
+					basic_username = params[:basic_username]
+					params.delete(:basic_username)
+				end
+				if params[:basic_password]
+					basic_password = params[:basic_password]
+					params.delete(:basic_password)
+				end
+
+				req_params = { :user => basic_username, :password => basic_password,
+					:method => method, :url => "#{Devtunnel.api_url}#{url}", :payload => params}
+
+				self.execute_request(req_params)
+
+			rescue Errno::ECONNREFUSED => e
+				raise ApiError.new(500, {}, {"errors" => [{"code" => 993, "message" => "Unable to connect to API server"}]})
+			rescue ExpiredApiKey => e
+				raise e
+			rescue InvalidApiKey => e
+				raise e
+      rescue Exception => e
+			# what kind of generic exceptions might we be loking for?
+				raise ApiError.new(500, {}, {"errors" => [{"code" => 996, "message" => "Error getting response from API server "+e.inspect}]})
+			end
+		end
+		
+		def self.execute_request(params)
+			if Devtunnel::Api.jack
+				ApiResponse.new Devtunnel::Api.jack.execute(params)
+			else
+				RestClient::Request.new(params).execute do |response, request, result, &block|
+					ApiResponse.new(response)
+				end
+			end
+		end
+
+		def self.xml_request method, url, params = {}
+				basic_username = 	Devtunnel.api_key
+				req_params = { :method => method, :url => url, :payload => params}
+
+				self.execute_xml_request(req_params)
+			
+		end
+
+		def self.execute_xml_request(params)
+			if Devtunnel::Api.jack
+				ApiResponse.new Devtunnel::Api.jack.execute(params)
+			else
+				RestClient::Request.new(params).execute do |response, request, result, &block|
+					response
+				end
+			end
+		end
+	end
+end

data/lib/devtunnel/api_error.rb

@@ -0,0 +1,15 @@
+module Devtunnel
+	class ApiError < StandardError
+		attr_accessor :status, :headers, :errors
+		def initialize(status, headers, body)
+			self.status = status
+			self.headers = headers
+			self.errors = body["errors"]
+		end
+	end
+
+	class ExpiredApiKey < ApiError; end
+	class InvalidApiKey < ApiError; end
+	class UnknownResponse < ApiError; end
+	class NilApiResponse < ApiError; end
+end

data/lib/devtunnel/api_model.rb

@@ -0,0 +1,38 @@
+module Devtunnel
+	module ApiModel
+
+    def self.included(base)
+			base.extend ClassMethods
+		end
+
+		def initialize(params = {})
+			populate(params)
+		end
+
+		def populate(params = {})
+			params.each do |k,v|
+        instance_variable_set "@#{k}", v
+			end
+		end
+	
+		module ClassMethods
+			attr_accessor :new_record, :errors
+		end	
+
+		def errors=(arr); @errors = arr; end
+		def errors; @errors; end
+
+		def new_record?
+			@new_record.nil? ? true : @new_record
+		end
+
+		def success?
+			@errors.nil?
+		end
+	
+		def attrs
+			{}.tap {|h| instance_variables.each { |var| h[var[1..-1]] = instance_variable_get(var) } }
+		end
+		
+	end
+end

data/lib/devtunnel/api_response.rb

@@ -0,0 +1,92 @@
+require_relative "entity"
+require "json"
+
+module Devtunnel
+	class ApiResponse
+		attr_accessor :_body, :_status, :_headers, :_entity, :errors
+
+		def initialize(response)
+			if response.nil? or response.body.nil? or response.code.nil? or response.headers.nil?
+				# this response is broken, raise an error.
+				raise NilApiResponse.new(500, {}, {"errors" => [{"code" => 990, "message" => "API Server sent back an empty response."}]})
+			end
+
+			self._body = ((response.body.is_a? String) ? JSON.parse(response.body) : response.body)
+			self._status = response.code
+			self._headers = response.headers
+
+			case _status
+			when 200, 201
+				self._entity = Devtunnel::Entity.new(_body)
+			when 400,401,403,404,500
+				if _body["errors"]
+					self.errors = _body["errors"]
+					# quickly look to see if we have authentication errors. We want to raise
+					# exceptions on api key errors.
+					case errors[0]["code"]
+					when "002"
+						raise InvalidApiKey.new(_status, _hearders, _body)
+					when "007"
+						raise ExpiredApiKey.new(_status, _hearders, _body)
+					end
+				end
+			else
+				# TODO: test unknown resonse and make sure the client can deal with it. 
+				raise UnknownResponse.new(_status, _headers, _body)
+			end
+		end
+
+		# enumeratable methods and such
+		def length
+			_entity.list.length if _entity.list
+		end
+		def first
+			if _entity.list
+				_entity.list.first
+			else
+				# TODO: some sort of exception
+			end
+		end
+
+		def success?
+			errors.nil? or errors.empty?
+		end
+
+		def total_results 
+			return nil unless _entity.meta
+			_entity.meta["total_results"]
+		end
+		def offset
+			return nil unless _entity.meta
+			_entity.meta["offset"]
+		end
+		def limit
+			return nil unless _entity.meta
+			_entity.meta["limit"]
+		end
+
+		# if we're trying to access a method directly on the ApiResponse,
+		# the user is probably trying to get an attribute directly from
+		# the single entity that was returned.  In this case, we'll simply
+		# look to see if the 
+		def method_missing(meth, *args, &block)
+			return nil unless _entity
+			if _entity.object
+				if _entity.object.respond_to? meth
+					_entity.object.send(meth, *args, &block)
+				else
+					raise NoMethodError.new("Unknown attribute #{meth} on ApiResponse or #{_entity.object.class} entity.")
+				end
+			elsif _entity.list
+				if _entity.list.respond_to? meth
+					_entity.list.send(meth, *args, &block)
+				else
+					raise NoMethodError.new("Unknown attribute #{meth} on ApiResponse or #{_entity.list.class} list.")
+				end
+			end
+		end
+
+	end
+	
+	class JsonParseError < StandardError; end
+end

data/lib/devtunnel/entity.rb

@@ -0,0 +1,49 @@
+require_relative "account"
+require_relative "success_response"
+
+module Devtunnel
+  class Entity
+    attr_accessor :list, :object, :meta
+
+    def initialize(json)
+      self.meta = json["meta"] if json["meta"]
+      if json["list"]
+        self.list = Entity.build_from_list(json["list"])
+      else
+        self.object = Entity.build_from_hash(json)
+      end
+    end
+
+    def self.build_from_list(list)
+      list.map do |e|
+        if e.is_a? Hash
+          self.build_from_hash(e)
+        elsif e.is_a? Array
+          self.build_from_list(e)
+        else
+          # TODO: throw some weird entity error
+        end
+      end
+    end
+
+    def self.build_from_hash(hash)
+      # our hash should always include a class attribute that we can use
+      # to map back to a proper Entity type
+      #
+      if !hash["success"].nil? and hash.keys.length == 1
+        return Devtunnel::SuccessResponse.new hash["success"]
+      end
+
+      hash["new_record"] = false
+      case hash["class"]
+        when "account"
+          Devtunnel::Account.new hash
+        else
+          raise NoSuchEntity.new("Unknown return type in API response data: #{hash["class"]}")
+      end
+    end
+  end
+
+  class NoSuchEntity < StandardError;
+  end
+end

data/lib/devtunnel/success_response.rb

@@ -0,0 +1,16 @@
+require_relative "api_model"
+
+module Devtunnel
+	class SuccessResponse
+		attr_accessor :success
+
+		def initialize success
+			self.success = success
+		end
+
+		def success?
+			success
+		end
+
+	end
+end

data/lib/devtunnel/version.rb

@@ -1,3 +1,3 @@
 module Devtunnel
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devtunnel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Bryan Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-04 00:00:00.000000000 Z
+date: 2013-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,7 +43,8 @@ description: Uses your DevTunnel account to quickly and easily tunnel a local de
   random NAT
 email:
 - bryan@madebymarket.com
-executables: []
+executables:
+- devtunnel
 extensions: []
 extra_rdoc_files: []
 files:
@@ -52,8 +53,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/devtunnel
 - devtunnel.gemspec
 - lib/devtunnel.rb
+- lib/devtunnel/account.rb
+- lib/devtunnel/api.rb
+- lib/devtunnel/api_error.rb
+- lib/devtunnel/api_model.rb
+- lib/devtunnel/api_response.rb
+- lib/devtunnel/entity.rb
+- lib/devtunnel/success_response.rb
 - lib/devtunnel/version.rb
 homepage: http://devtunnel.labs.madebymarket.com
 licenses: