apihub 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d231af661f63c2dc86ddfe2da989e9712799c342
-  data.tar.gz: a0a51be9f1547752c47489bd6cbfa2c636453e34
+  metadata.gz: 968c7728de504c70dd18e6e8a07ede0c86208eea
+  data.tar.gz: ebf452723ba3193ef318d7173c5489f4f2ee385d
 SHA512:
-  metadata.gz: e0b8a236f1b7959d2d8878144bb0fd4cede913f15181f662347087a469042dc4d98cf122d0d0420193ed32e5c593d328e89b08a4bcc72ad5c1a60c277cd3395b
-  data.tar.gz: a4972990d7942613761a32f30260e0b0982c6069d02600b934bf6796a260c63afbc09cff82a5dd6eab0e0e4e00c10f07ff08cef8bbe917853b0b13feb737ac89
+  metadata.gz: 4f439d4701289989682fc21f06f4b3b9312709d744d213d0a7babfbf2294877c28cda23101faa53b40085d26235548e56623700788f4afdcff965349cc1f2115
+  data.tar.gz: 23c14c0544c262886bb8c32774b0557cff0a4404dc880d56c07c35e6cf01a2200e92df6d56e56e655308d0ca61df73cc184c87fb828cfc070f50124bfc805286

data/README.md

@@ -40,6 +40,21 @@ If the company can't be found, then `nil` will be returned.
 
 See the [documentation](https://apihub.co/docs/company) for more information.
 
+## Streaming requests
+
+Often you'll want people or company lookups to block, rather than return blank `202` requests if we need to look up data. You can do this using APIHub's streaming API.
+
+For example, to look up a company by domain using our streaming API use the `APIHub::Streaming::Company` class:
+
+    company = APIHub::Streaming::Company[domain: 'uber.com']
+
+If we need to lookup the company, we'll block the network request for 10-20 seconds before responding. This is ideal for scenarios where long network requests don't really matter, such as job queues. Often the streaming API will be easier to implement than webhooks.
+
+You can similarity look up people using the `APIHub::Streaming::Person` class.
+
+    person = APIHub::Streaming::Person[email: 'info@eribium.org']
+
+
 ## CLI
 
 The gem also includes a `apihub` executable, which you can use like this:

data/bin/apihub

@@ -18,14 +18,6 @@ values  = {}
 parser  = OptionParser.new do |opts|
   opts.banner = "Usage: apihub [person|company] [options]"
 
-  opts.on("--twitter HANDLE", String, "Twitter handle") do |v|
-    values[:twitter] = v
-  end
-
-  opts.on("--github HANDLE", String, "GitHub handle") do |v|
-    values[:github] = v
-  end
-
   opts.on("--email EMAIL", String, "Email") do |v|
     values[:email] = v
   end
@@ -43,9 +35,9 @@ parser.parse!
 
 case ARGV[0]
 when 'person'
-  entity = APIHub::Person
+  entity = APIHub::Streaming::Person
 when 'company'
-  entity = APIHub::Company
+  entity = APIHub::Streaming::Company
 else
   puts parser
   exit
@@ -60,11 +52,17 @@ if key = ENV['APIHUB_KEY']
   options[:api_key] ||= key
 end
 
+if key = options.delete(:api_key)
+  APIHub.api_key = key
+else
+  puts 'API Key required'
+  puts parser
+  exit
+end
+
 object = entity.find(values, options)
 
-if object && object.pending?
-  puts 'Lookup queued'
-elsif object
+if object
   ap object.to_hash
 else
   puts 'Not found'

data/lib/apihub.rb

@@ -18,4 +18,5 @@ module APIHub
   autoload :Mash, 'apihub/mash'
   autoload :Person, 'apihub/person'
   autoload :Resource, 'apihub/resource'
+  autoload :Streaming, 'apihub/streaming'
 end

data/lib/apihub/company.rb

@@ -1,6 +1,6 @@
 module APIHub
   class Company < Base
-    endpoint 'https://company-stream.apihub.co'
+    endpoint 'https://company.apihub.co'
     path '/v1/companies'
 
     def self.find(values, options = {})
@@ -21,7 +21,11 @@ module APIHub
         raise ArgumentError, 'Invalid values'
       end
 
-      self.new(response)
+      if response.status == 202
+        self.new(pending: true)
+      else
+        self.new(response)
+      end
 
     rescue Nestful::ResourceNotFound
     end

data/lib/apihub/person.rb

@@ -1,6 +1,6 @@
 module APIHub
   class Person < Base
-    endpoint 'https://person-stream.apihub.co'
+    endpoint 'https://person.apihub.co'
     path '/v1/people'
 
     def self.find(values, options = {})
@@ -27,7 +27,11 @@ module APIHub
         raise ArgumentError, 'Invalid values'
       end
 
-      self.new(response)
+      if response.status == 202
+        self.new(pending: true)
+      else
+        self.new(response)
+      end
 
     rescue Nestful::ResourceNotFound
     end

data/lib/apihub/streaming.rb

@@ -0,0 +1,6 @@
+module APIHub
+  module Streaming
+    autoload :Company, 'apihub/streaming/company'
+    autoload :Person, 'apihub/streaming/person'
+  end
+end

data/lib/apihub/streaming/company.rb

@@ -0,0 +1,7 @@
+module APIHub
+  module Streaming
+    class Company < APIHub::Company
+      endpoint 'https://company-stream.apihub.co'
+    end
+  end
+end

data/lib/apihub/streaming/person.rb

@@ -0,0 +1,7 @@
+module APIHub
+  module Streaming
+    class Person < APIHub::Person
+      endpoint 'https://person-stream.apihub.co'
+    end
+  end
+end

data/lib/apihub/version.rb

@@ -1,3 +1,3 @@
 module APIHub
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apihub
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Alex MacCaw
@@ -74,6 +74,9 @@ files:
 - lib/apihub/mash.rb
 - lib/apihub/person.rb
 - lib/apihub/resource.rb
+- lib/apihub/streaming.rb
+- lib/apihub/streaming/company.rb
+- lib/apihub/streaming/person.rb
 - lib/apihub/version.rb
 homepage: https://github.com/maccman/apihub-ruby
 licenses: