knodes 0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTc2YjYwYzJjNzA1NzQyNWFjODEwMGE5M2Y1YTY5OGRjMjVmMGYxZA==
+  data.tar.gz: !binary |-
+    OGZmMDFmNTdmN2QxYjIzZjBjODBiNjAwMWY5NDRlZDdjYTFkMjBkMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OTU1ZmMxNjkwNTc4ZmExZWRmYmMzOTdkNjZiZDQwY2FjNzA3NmE4YWE1Yzc5
+    MDU2NmU4ZjU2NDkwZDhiNjJlNGRmODFjZmMwYjZiY2UxMDJlYWNiNTA0NDcz
+    ZjJhMGY0MWY5NDcyMDc4MzBkMWRjOGFiYWNiNjRjM2Y2MzU3NTE=
+  data.tar.gz: !binary |-
+    ZjM2NGY5YWQ2N2ZkZGQ5NWRjNzE0ZDgxNWY2YzQ0NjA5YzZkNmY3MGMyMTM5
+    NGVhMGY2YzkyOWVmNzA2ZjE1YTU3MmQ2MjdlYTcyYzMwNzE2ZmRlZGNjYmY2
+    ZTlmZjZhMTMxZjI5MzM1NmE2MDk5N2FhZjQzODM3MWJhZDdmMzc=

data/.env

@@ -0,0 +1,14 @@
+# EXAMPLE ENV FILE
+
+CUSTOMER_ID=customer_id
+CUSTOMER_SECRET=customer_secret
+TEST_APP_ID=test_app_id
+TEST_APP_SECRET=test_app_secret
+TEST_USER_ID=test_user_id
+TEST_NETWORK_ID=test_network_id
+TEST_NETWORK_TOKEN=test_network_token
+TEST_PERSON_ID=test_person_id
+TEST_DOC_ID=test_doc_id
+TEST_LOCATION_ID=test_location_id
+TEST_COMPANY_ID=test_company_id
+TEST_SCHOOL_ID=test_school_id

data/.gitignore

@@ -0,0 +1,6 @@
+
+spec/.DS_Store
+
+.DS_Store
+
+*.gem

data/Gemfile

@@ -0,0 +1,21 @@
+source :rubygems
+
+  gem 'faraday'
+  gem 'faraday_middleware'
+  gem 'hashie'
+
+group :development do
+  gem 'guard'
+  gem 'rb-fsevent'
+  gem 'growl'
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+  gem 'guard-cucumber'
+end
+
+group :development, :test do
+  gem 'cucumber'
+  gem 'rspec'
+  gem 'dotenv'
+end
+

data/Gemfile.lock

@@ -0,0 +1,59 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.1.4)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    diff-lcs (1.1.3)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.8.8)
+      faraday (>= 0.7.4, < 0.9)
+    gherkin (2.11.5)
+      json (>= 1.4.6)
+    growl (1.0.3)
+    guard (1.4.0)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-bundler (1.0.0)
+      bundler (~> 1.0)
+      guard (~> 1.1)
+    guard-cucumber (1.2.0)
+      cucumber (>= 1.2.0)
+      guard (>= 1.1.0)
+    guard-rspec (2.1.0)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    hashie (1.2.0)
+    json (1.7.5)
+    listen (0.5.3)
+    multipart-post (1.1.5)
+    rb-fsevent (0.9.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    thor (0.16.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber
+  faraday
+  faraday_middleware
+  growl
+  guard
+  guard-bundler
+  guard-cucumber
+  guard-rspec
+  hashie
+  rb-fsevent
+  rspec

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  # Uncomment next line if Gemfile contain `gemspec' command
+  # watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :cli => "--color --format doc" do
+  watch(%r{^spec/.+_spec\.rb$})
+  #watch(%r{^lib/(.+)\.rb$})     { |m| puts m.inspect }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+  watch('lib/knodes.rb.') { "spec/" }
+end

data/README.md

@@ -0,0 +1,81 @@
+#Knodes Ruby Client Library
+
+A ruby client library for the Knodes API  
+See full API documentation at http://developer.kno.des/
+
+## Usage
+
+### Installation
+
+Install the gem:  
+```gem install knodes-client```  
+or, add it to your Gemfile:  
+```gem 'knodes-client'```  
+```bundle install```
+
+###Configuration
+```ruby
+Knodes.configure do |config| 
+config.customer_id = "foo"
+config.customer_secret = "bar"
+end
+```
+
+###Examples
+
+Get the customer details  
+```response = Knodes.customer```
+
+Search for a person  
+```response = Knodes.people_search(:user_id=>user_id, :person_id=>"self", :q=>"Joe Schmoe")```
+
+Get a person's details  
+```response = Knodes.person(:user_id=>user_id, :person_id=>person_id)```
+
+Search for a location  
+```response = Knodes.locations_search(:user_id=>user_id, :q=>"New York")```
+
+## Motivation
+
+Discovered Knodes at the 2012 TechCrunch Hackathon, won the API prize for the YourQ project.  After changing the name to Que.io, we discovered that we needed a better client library, so I built it.  Gained inspiration from the client libraries for Podio and Instagram.
+
+## Knodes API Reference
+
+View the getting started guide here:  
+http://developer.knod.es/getting_started
+
+View the API docs here:  
+http://developer.knod.es/docs
+
+## Tests
+
+The tests rely on sample data from your social networks.
+Sign up for an account here:
+https://api.knod.es/portal/signup
+
+Then, use the test harness to get your customer data. From there you can use this client to get the rest of the sample data.  
+Put your sample data into .env (sample file provided)  
+Then, to run the tests, you can use Guard for autotesting, or just vanilla Rspec:
+
+```bundle exec guard```
+
+## Contributors
+
+If you discover a bug or want to contribute extra functionality:
+
+1. Fork it.
+2. Create a branch (`git checkout -b feature_or_bug_branch`)
+3. Commit your changes (`git commit -am "Added feature, fixed bug"`)
+4. Push to the branch (`git push origin feature_or_bug_branch`)
+5. Open a Pull Request
+6. ...
+7. Profit
+
+## License
+
+This client library is released under the Apache license, Version 2.0
+http://www.apache.org/licenses/LICENSE-2.0.html  
+
+Knodes and all other trademarks are © 2013 SnapGoods, Inc. All Rights Reserved.  
+http://knod.es/content/tos.pdf  
+http://knod.es/content/customer_agreement.pdf

data/knodes.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "knodes"
+  s.rubyforge_project = s.name
+  s.version     = Knodes::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matt Anderson"]
+  s.email       = ["matthewrossanderson@gmail.com"]
+  s.homepage    = "http://developer.knod.es/"
+  s.summary     = %q{A ruby client library for the Knodes API}
+  s.description = %q{See API documentation at http://developer.knod.es/}
+  s.license     = "Apache 2.0"
+  s.post_install_message =<<eos
+********************************************************************************
+
+Thanks for installing the Knodes client library!
+
+See API documentation at http://developer.knod.es/
+
+There's always money in the banana stand.
+
+********************************************************************************
+eos
+
+  s.add_development_dependency "rspec", "~>2.5.0"
+  s.add_runtime_dependency "faraday"
+  s.add_runtime_dependency "faraday_middleware"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/faraday/knodes_errors.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require File.expand_path('../../knodes/error', __FILE__)
+
+module FaradayMiddleware
+  class KnodesErrors < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response[:status].to_i
+          when 400
+            raise Knodes::BadRequest, response[:body]
+            #puts "#{finished_env[:body] if finished_env[:body]}"
+          when 404
+            raise Knodes::NotFound, response[:body]
+            #puts "#{finished_env if finished_env[:body]}"
+        end
+      end
+    end
+    def initialize(app)
+        super app
+        @parser = nil
+    end
+  end
+end

data/lib/knodes.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require File.expand_path('../knodes/configuration', __FILE__)
+require File.expand_path('../knodes/connection', __FILE__)
+require File.expand_path('../knodes/request', __FILE__)
+require File.expand_path('../knodes/client', __FILE__)
+
+module Knodes
+  extend Configuration
+
+  #Knodes module methods#
+  
+  # Alias for Knodes::Client.new
+  def self.client(options={})
+    Knodes::Client.new(options)
+  end
+
+  # Delegate to Knodes::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Knodes::Client
+  def self.respond_to?(method)
+    return client.respond_to?(method) || super
+  end
+end

data/lib/knodes/client.rb

@@ -0,0 +1,35 @@
+module Knodes
+  class Client
+
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    # Creates a new client and sets configuration to passed options or their default values
+    def initialize(options={}) 
+      options = Knodes.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    #convenience method for returning id/secret
+    def creds
+      Hash["customer_id" => customer_id, "customer_secret" => customer_secret]
+    end
+
+    include Connection
+    include Request
+
+    #here comes the good stuff.  
+    #these refer to modules separated by Knodes resources, containing methods for each api call
+
+    include Customers
+    include Users
+    include People
+    include Documents
+    include Locations
+    include Companies
+    include Schools
+  end 
+end

data/lib/knodes/client/companies.rb

@@ -0,0 +1,17 @@
+module Knodes
+	class Client
+		module Companies
+      def company(options={})
+        response = get("companies/#{options[:company_id]}", options.merge(creds))
+      end
+
+      def companies_search(options={})
+        response = get("companies/search", options.merge(creds))
+      end
+
+      def company_people(options={})
+        response = get("companies/#{options[:company_id]}/people", options.merge(creds))
+      end
+    end
+	end
+end

data/lib/knodes/client/customers.rb

@@ -0,0 +1,17 @@
+module Knodes
+  class Client
+    module Customers
+    	def customer
+    		response = get("customers", creds)
+   		end
+
+      def customer_connect(options={})
+        response = post("customers/#{options[:customer_id]}/connect", options = options.merge(creds))
+      end
+
+      def customer_disconnect(options={})
+        response = post("customers/#{options[:customer_id]}/disconnect", options = options.merge(creds))
+      end
+    end
+  end
+end

data/lib/knodes/client/documents.rb

@@ -0,0 +1,21 @@
+module Knodes
+	class Client
+    module Documents
+      def document(options={})
+        response = get("documents/#{options[:doc_id]}", options.merge(creds))
+      end
+
+      def documents_search(options={})
+        response = get("documents/search", options.merge(creds))
+      end
+
+      def document_people(options={})
+        response = get("documents/#{options[:doc_id]}/people", options.merge(creds))
+      end
+
+      def document_locations(options={})
+        response = get("documents/#{options[:doc_id]}/locations", options.merge(creds))
+      end
+    end
+	end
+end

data/lib/knodes/client/locations.rb

@@ -0,0 +1,21 @@
+module Knodes
+	class Client
+    module Locations
+      def location(options={})
+        response = get("locations/#{options[:location_id]}", options.merge(creds))
+      end
+
+      def locations_search(options={})
+        response = get("locations/search", options.merge(creds))
+      end
+
+      def location_people(options={})
+        response = get("locations/#{options[:location_id]}/people", options.merge(creds))
+      end
+
+      def location_documents(options={})
+        response = get("locations/#{options[:location_id]}/documents", options.merge(creds))
+      end
+    end
+	end
+end

data/lib/knodes/client/people.rb

@@ -0,0 +1,35 @@
+module Knodes
+	class Client
+  	module People
+      def person(options={})
+        response = get("people/#{options[:person_id]}", options.merge(creds))
+      end
+
+      def people_search(options={})
+        options.merge!({ :type=> "people" })
+        response = get("people/search", options.merge(creds))
+      end
+
+      def person_people(options={})
+        options.merge!({:type=>"people", :q=>""})
+        response = get("search", options.merge(creds))
+      end
+
+      def person_documents(options={})
+        response = get("people/#{options[:person_id]}/documents", options.merge(creds))
+      end
+
+      def person_locations(options={})
+        response = get("people/#{options[:person_id]}/locations", options.merge(creds))
+      end
+
+      def person_companies(options={})
+        response = get("people/#{options[:person_id]}/documents", options.merge(creds))
+      end
+
+      def person_schools(options={})
+        response = get("people/#{options[:person_id]}/documents", options.merge(creds))
+      end
+    end
+	end
+end

data/lib/knodes/client/schools.rb

@@ -0,0 +1,17 @@
+module Knodes
+	class Client
+		module Schools
+      def school(options={})
+        response = get("schools/#{options[:school_id]}", options.merge(creds))
+      end
+
+      def schools_search(options={})
+        response = get("schools/search", options.merge(creds))
+      end
+
+      def school_people(options={})
+        response = get("schools/#{options[:school_id]}/people", options.merge(creds))
+      end
+    end
+	end
+end

data/lib/knodes/client/users.rb

@@ -0,0 +1,41 @@
+module Knodes
+	class Client
+    module Users
+  		def user(options={})
+  			response = get("users/#{options[:user_id]}", options.merge(creds))
+    	end
+
+      def user_connect(options={})
+        response = post("users/connect", options.merge(creds))
+      end
+
+      def user_disconnect(options={})
+        response = post("users/disconnect", options.merge(creds))
+      end
+
+      def user_update(options={})
+        response = post("users/#{options[:user_id]}", options.merge(creds))
+      end
+
+      def user_notify_active(options={})
+        response = post("users/notify_active", options.merge(creds))
+      end
+
+      def user_notify_inactive(options={})
+        #do a raw request/response (don't parse), as this method only returns an http status
+        response = post("users/notify_inactive", options.merge(creds), true)
+        status = response.env[:status]
+      end
+
+      def user_ready(options={})
+        response = get("users/#{options[:user_id]}/ready", options.merge(creds), true)
+        body = response.env[:body]
+      end
+
+      def user_do_index(options={})
+        response = post("users/#{options[:user_id]}/do_index", options.merge(creds), true)
+        status = response.env[:status]
+      end
+    end
+	end
+end

data/lib/knodes/configuration.rb

@@ -0,0 +1,67 @@
+module Knodes
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :customer_id,
+      :customer_secret,
+      :endpoint,
+      :adapter,
+      :format,
+      :proxy,
+      :user_agent
+    ].freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    ##DEFAULT CONSTANTS##
+
+    # The adapter that will be used to connect if none is set
+    # The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set a customer ID
+    DEFAULT_CUSTOMER_ID = nil
+
+    # By default, don't set a customer secret
+    DEFAULT_CUSTOMER_SECRET = nil
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = 'https://api.knod.es/'
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    # JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = 'KnodesRubyClient/1.0'
+
+    #allow config values to be set in a block
+    def configure
+      yield self
+    end
+
+    #return hash of options
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.adapter         = DEFAULT_ADAPTER
+      self.customer_id     = DEFAULT_CUSTOMER_ID
+      self.customer_secret = DEFAULT_CUSTOMER_SECRET
+      self.endpoint        = DEFAULT_ENDPOINT
+      self.format          = DEFAULT_FORMAT
+      self.proxy           = DEFAULT_PROXY
+      self.user_agent      = DEFAULT_USER_AGENT
+     end
+  end
+end

data/lib/knodes/connection.rb

@@ -0,0 +1,23 @@
+#require the shiny custom middleware
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module Knodes
+  module Connection
+  	def connection(raw=false)
+  		options = {
+        :headers => {'Accept' => "application/#{format}; charset=utf-8", 'User-Agent' => user_agent},
+        :proxy => proxy,
+        :ssl => {:verify => false},
+        :url => endpoint,
+      }
+
+  		Faraday::Connection.new(options) do |connection|
+        connection.request :url_encoded
+        connection.response :mashify unless raw
+        connection.response :json, content_type: 'application/json' unless raw  
+        connection.use FaradayMiddleware::KnodesErrors
+        connection.adapter(adapter)
+  		end
+  	end
+  end
+end

data/lib/knodes/error.rb

@@ -0,0 +1,10 @@
+module Knodes
+  # Custom error class for rescuing from all Knodes errors
+  class Error < StandardError; end
+
+  # Raised when Knodes returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Knodes returns the HTTP status code 404
+  class NotFound < Error; end
+end

data/lib/knodes/request.rb

@@ -0,0 +1,46 @@
+module Knodes
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, raw=false, unformatted=false, debug=false)
+      request(:get, path, options, raw, unformatted, debug)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, raw=false, unformatted=false, debug=false)
+      request(:post, path, options, raw, unformatted, debug)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={}, raw=false, unformatted=false, debug=false)
+      request(:put, path, options, raw, unformatted, debug)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={}, raw=false, unformatted=false, debug=false)
+      request(:delete, path, options, raw, unformatted, debug)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options, raw=false, unformatted=false, debug=false)
+      response = connection(raw).send(method) do |request|
+        path = formatted_path(path) unless unformatted
+        case method
+        when :get, :delete
+          request.url(path, options)
+        when :post, :put
+          request.path = path
+          request.body = options unless options.empty?
+        end
+
+        puts response.inspect if debug
+      end
+      raw ? response : response.body
+    end
+
+    def formatted_path(path)
+      [path, format].compact.join('.')
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Knodes
+	VERSION = "0.3"
+end

data/spec/lib/knodes_spec.rb

@@ -0,0 +1,378 @@
+require 'spec_helper'
+
+describe Knodes::Client do
+	before do
+		Knodes.configure do |config|
+			config.customer_id = ENV['CUSTOMER_ID']
+			config.customer_secret = ENV['CUSTOMER_SECRET']
+		end
+	end			
+
+	context "Client" do
+		it "should make a client" do
+			c = Knodes.client
+			c.should be_an_instance_of (Knodes::Client)
+		end
+
+		it "should allow me to set configuration in a block " do
+			Knodes.configure do |config|
+				config.customer_id = "foo"
+				config.customer_secret = "bar"
+			end
+			#puts Knodes.customer_id
+			Knodes.customer_id.should == "foo"
+		end
+
+		it "should instantiate using default configuration values" do
+		    c = Knodes::Client.new
+			c.endpoint.should == "https://api.knod.es/"
+	  	end
+
+		it "should instantiate using specified configuration values" do
+			c = Knodes.client(:customer_id=>"foo", :customer_secret=>"bar")
+			c.customer_id.should == "foo" 
+			c.customer_secret.should == "bar"
+		end
+
+	end
+
+	context "Customers" do
+		before do
+			@test_app_id = ENV['TEST_APP_ID']
+			@test_app_secret = ENV['TEST_APP_SECRET']
+			#Knodes = Knodes.client(:customer_id=>@test_customer_id, :customer_secret=>@test_customer_secret)	
+		end
+
+		it "should connect to the customer endpoint" do
+			response = Knodes.customer
+			#puts response
+			#puts "\nCustomer App Name: #{response.name}\n"
+			response.should have_key(:name)
+		end
+
+		it "should disconnect a customer network app" do
+			#response = Knodes.customer_disconnect(:network=>"facebook")
+			#puts response.network_apps
+			pending("don't want to run this every time")
+			#response.network_apps.should_not have_key(:facebook)
+		end
+
+		it "should connect a customer network app" do
+			#response = Knodes.customer_connect(:network=>"facebook", :id=>@test_app_id, :secret=>@test_app_secret)
+			#puts response.network_apps
+			pending("don't want to run this every time")
+			#response.network_apps.should have_key(:facebook)
+		end
+	end
+
+	context "Users" do
+		before do
+			@test_user_id = ENV['TEST_USER_ID']
+			@test_network_id = ENV['TEST_NETWORK_ID']
+			@test_network_token = ENV['TEST_NETWORK_TOKEN']
+			#@c = Knodes.client(:customer_id=>@test_customer_id, :customer_secret=>@test_customer_secret)	
+		end
+
+		it "should return a user" do
+			response = Knodes.user(:user_id=>@test_user_id)
+			#puts "\nUser Name: #{response.name}"
+			#puts response.inspect
+			response.should have_key(:name)
+		end
+
+		it "should fail gracefully with an incorrect id" do
+			lambda {
+				Knodes.user(:user_id=>"yo_i_got_a_fake_id")
+			}.should raise_error(Knodes::NotFound, "invalid action")
+		end
+
+		it "should disconnect a user's network account" do
+			#response = Knodes.user_disconnect(:user_id=>@test_user_id, :network=>"facebook", :network_id=>@test_network_id)
+			#puts "User networks: #{response.networks}"
+			#pending("don't want to run this every time")
+			response.networks.should_not have_key(:facebook)
+		end
+
+		it "should connect a user's network account" do
+			response = Knodes.user_connect(:network=>"facebook", :network_id=>@test_network_id, :token=>@test_network_token)
+			puts response.inspect
+			#pending("don't want to run this every time")
+			response.networks.should have_key(:facebook)
+		end
+
+		it "should notify_inactive" do
+			response = Knodes.user_notify_inactive(:user_id=>@test_user_id)
+			#puts "\nNotify inactive status: #{response}"
+			response.should == 200
+		end
+
+		it "should notify_active" do
+			response = Knodes.user_notify_active(:user_id=>@test_user_id)
+			#puts "\nNotify active user name: #{response.name}"
+			#puts "\nNotify active ready status: #{response.ready}"
+			response.should have_key(:name)
+			response.ready.should == "ok" || response.ready.should == "indexing"
+		end
+
+		it "should return ready status" do
+			response = Knodes.user_ready(:user_id=>@test_user_id)
+			#puts "\nReady status: #{response}"
+			response.should == "ok" || response.ready.should == "indexing"
+		end
+
+		it "should initiate a user index" do
+			#response = Knodes.user_do_index(:user_id=>@test_user_id)
+			#puts "\nUser index status: #{response}"
+			#response.should == 200
+			pending ("dont want to hit knodes too hard")
+		end
+
+		it "should update a users email address" do
+			response = Knodes.user_update(:user_id=>@test_user_id, :email=>"test@example.com")
+			response.email.should == "test@example.com"
+		end
+	end
+
+	context "People" do
+		before do 
+			@test_user_id = ENV['TEST_USER_ID']
+			@test_person_id = ENV['TEST_PERSON_ID']
+			#@c = Knodes.client(:customer_id=>@test_customer_id, :customer_secret=>@test_customer_secret)	
+		end
+
+		it "should return a person" do
+			response = Knodes.person(:user_id=>@test_user_id, :person_id=>@test_person_id)
+			#puts response.inspect
+			response.should have_key(:name)
+		end
+
+		it "should search for people" do
+			response = Knodes.people_search(:user_id=>@test_user_id, :person_id=>"self", :q=>"Person")
+			#puts response.results
+			response.results.should_not be_empty
+		end
+		
+		it "should search for people and fail gracefully" do
+			response = Knodes.people_search(:user_id=>@test_user_id, :q=>"Unknown")
+			#puts response
+			response.should have_key(:total)
+		end
+
+		it "should find people associated with self" do
+			response = Knodes.person_people(:user_id=>@test_user_id, :person_id=>"self")	
+			#puts response.inspect
+			response.results.should_not be_empty
+		end
+
+		it "should find people associated with a person" do
+			response = Knodes.person_people(:user_id=>@test_user_id, :person_id=>@test_person_id)	
+			#puts response.inspect
+			#response.results.should_not be_empty
+			pending "further testing"
+		end
+
+		it "should find documents associated with a person" do
+			response = Knodes.person_documents(:user_id=>@test_user_id, :person_id=>@test_person_id, :q=>"")
+			response.should have_key(:total)
+		end
+
+		it "should find locations associated with a person" do
+			response = Knodes.person_locations(:user_id=>@test_user_id, :person_id=>@test_person_id, :q=>"")
+			response.should have_key(:total)
+		end
+
+		it "should find companies associated with a person" do
+			response = Knodes.person_companies(:user_id=>@test_user_id, :person_id=>@test_person_id, :q=>"")
+			response.should have_key(:total)
+		end
+
+		it "should find schools associated with a person" do
+			response = Knodes.person_schools(:user_id=>@test_user_id, :person_id=>@test_person_id, :q=>"")
+			response.should have_key(:total)
+		end
+	end
+
+	context "Documents" do
+		before do 
+			@test_user_id = ENV['TEST_USER_ID']
+			@test_person_id = ENV['TEST_PERSON_ID']
+			@test_doc_id = ENV['TEST_DOC_ID']
+			#@c = Knodes.client(:customer_id=>@test_customer_id, :customer_secret=>@test_customer_secret)	
+		end
+
+		it "should return a document" do
+			response = Knodes.document(:user_id=>@test_user_id, :doc_id=>@test_doc_id)
+			#puts response.inspect
+			response.should have_key(:id)
+		end
+
+		it "should search for documents" do
+			response = Knodes.documents_search(:user_id=>@test_user_id, :q=>"profile")
+			#puts response.results
+			response.total.should > 0
+		end
+		
+		it "should search for documents and fail gracefully" do
+			response = Knodes.documents_search(:user_id=>@test_user_id, :type=> "document", :q=>"Unknown")
+			#puts response
+			response.should have_key(:total)
+		end
+
+		it "should find documents associated with self" do
+			response = Knodes.documents_search(:user_id=>@test_user_id, :q=>"")	
+			#puts response.inspect
+			response.total.should > 0
+		end
+
+		it "should find people associated with a document" do
+			response = Knodes.document_people(:user_id=>@test_user_id, :doc_id=>@test_doc_id) 
+			#puts response.inspect
+			pending "finding a document with associated people"
+			response.total.should > 0
+		end
+
+		it "should find locations associated with a document" do
+			response = Knodes.document_locations(:user_id=>@test_user_id, :doc_id=>@test_doc_id)
+			#puts response.inspect
+			pending "finding a document with a location"
+			response.total.should > 0
+		end
+	end
+
+	context "Locations" do
+		before do 
+			@test_user_id = ENV['TEST_USER_ID'] 
+			@test_person_id = ENV['TEST_PERSON_ID'] 
+			@test_location_id = ENV['TEST_LOCATION_ID'] 
+			#@c = Knodes.client(:customer_id=>@test_customer_id, :customer_secret=>@test_customer_secret)	
+		end
+
+		it "should return a location" do
+			response = Knodes.location(:user_id=>@test_user_id, :location_id=>@test_location_id)
+			#puts response.inspect
+			response.should have_key(:id)
+		end
+
+		it "should search for locations" do
+			response = Knodes.locations_search(:user_id=>@test_user_id, :q=>"New York")
+			#puts response.results
+			response.total.should > 0
+		end
+		
+		it "should search for locations and fail gracefully" do
+			response = Knodes.locations_search(:user_id=>@test_user_id, :type=> "location", :q=>"Unknown")
+			#puts response
+			response.should have_key(:total)
+		end
+
+		it "should find locations associated with self" do
+			response = Knodes.locations_search(:user_id=>@test_user_id, :q=>"")	
+			#puts response.inspect
+			response.total.should > 0
+		end
+
+		it "should find people associated with a location" do
+			response = Knodes.location_people(:user_id=>@test_user_id, :location_id=>@test_location_id) 
+			#puts response.inspect
+			#response.total.should > 0
+			pending "finding a location with people"
+		end
+
+		it "should find documents associated with a location" do
+			response = Knodes.location_documents(:user_id=>@test_user_id, :location_id=>@test_location_id)
+			#puts response.inspect
+			#response.total.should > 0
+			pending "finding a location with documents"
+		end
+	end
+
+	context "Companies" do
+		before do 
+			@test_user_id = ENV['TEST_USER_ID']
+			@test_person_id = ENV['TEST_PERSON_ID']
+			@test_company_id = ENV['TEST_COMPANY_ID']
+			#@c = Knodes.client(:customer_id=>@test_customer_id, :customer_secret=>@test_customer_secret)	
+		end
+
+		it "should return a company" do
+			pending "finding a company"
+			response = Knodes.company(:user_id=>@test_user_id, :company_id=>@test_company_id)
+			#puts response.inspect
+			#response.should have_key(:id)
+			
+		end
+
+		it "should search for companies" do
+			pending "finding a company"
+			response = Knodes.companies_search(:user_id=>@test_user_id, :q=>"New York")
+			#puts response.results
+			#response.total.should > 0
+		end
+		
+		it "should search for companies and fail gracefully" do
+			response = Knodes.companies_search(:user_id=>@test_user_id, :type=> "company", :q=>"Unknown")
+			#puts response
+			response.should have_key(:total)
+		end
+
+		it "should find companies associated with self" do
+			pending "finding a company"
+			response = Knodes.companies_search(:user_id=>@test_user_id, :q=>"")	
+			#puts response.inspect
+			#response.total.should > 0
+		end
+
+		it "should find people associated with a company" do
+			pending "finding a company"
+			response = Knodes.company_people(:user_id=>@test_user_id, :company_id=>@test_company_id) 
+			#puts response.inspect
+			#response.total.should > 0
+		end
+	end
+
+	context "Schools" do
+		before do 
+			@test_user_id = ENV['TEST_USER_ID'] #
+			@test_person_id = ENV['TEST_PERSON_ID'] 
+			@test_school_id = ENV['TEST_SCHOOL_ID'] 
+			#@c = Knodes.client(:customer_id=>@test_customer_id, :customer_secret=>@test_customer_secret)	
+		end
+
+		it "should return a school" do
+			response = Knodes.school(:user_id=>@test_user_id, :school_id=>@test_school_id)
+			# puts response.inspect
+			response.should have_key(:id)
+			
+		end
+
+		it "should search for schools" do
+			response = Knodes.schools_search(:user_id=>@test_user_id, :q=>"Rensselaer")
+			#puts response.results
+			response.total.should > 0
+		end
+		
+		it "should search for schools and fail gracefully" do
+			response = Knodes.schools_search(:user_id=>@test_user_id, :type=> "school", :q=>"Unknown")
+			#puts response
+			response.should have_key(:total)
+		end
+
+		it "should find schools associated with self" do
+			response = Knodes.schools_search(:user_id=>@test_user_id, :q=>"")	
+			#puts response.inspect
+			response.total.should > 0
+		end
+
+		it "should find people associated with a school" do
+			response = Knodes.school_people(:user_id=>@test_user_id, :school_id=>@test_school_id) 
+			#puts response.inspect
+			response.total.should > 0
+		end
+	end
+
+end
+
+
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'rack/test'
+require 'dotenv'
+
+Dotenv.load
+Dir[File.expand_path('../../lib/*.rb', __FILE__)].each{|f| require f}
+ENV['RACK_ENV'] = 'test'
+set :environment, :test

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: knodes
+version: !ruby/object:Gem::Version
+  version: '0.3'
+platform: ruby
+authors:
+- Matt Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !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: faraday_middleware
+  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'
+description: See API documentation at http://developer.knod.es/
+email:
+- matthewrossanderson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .env
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- knodes.gemspec
+- lib/.DS_Store
+- lib/faraday/knodes_errors.rb
+- lib/knodes.rb
+- lib/knodes/client.rb
+- lib/knodes/client/companies.rb
+- lib/knodes/client/customers.rb
+- lib/knodes/client/documents.rb
+- lib/knodes/client/locations.rb
+- lib/knodes/client/people.rb
+- lib/knodes/client/schools.rb
+- lib/knodes/client/users.rb
+- lib/knodes/configuration.rb
+- lib/knodes/connection.rb
+- lib/knodes/error.rb
+- lib/knodes/request.rb
+- lib/version.rb
+- spec/lib/.github
+- spec/lib/knodes_spec.rb
+- spec/spec_helper.rb
+homepage: http://developer.knod.es/
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: ! '********************************************************************************
+
+
+  Thanks for installing the Knodes client library!
+
+
+  See API documentation at http://developer.knod.es/
+
+
+  There''s always money in the banana stand.
+
+
+  ********************************************************************************
+
+'
+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: knodes
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A ruby client library for the Knodes API
+test_files:
+- spec/lib/.github
+- spec/lib/knodes_spec.rb
+- spec/spec_helper.rb