zulip 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7104e27dedb5006e5b02e35bf0a8cadf8c74985b
-  data.tar.gz: a33826034e2546c0ef6957b1e41bde933ae5b342
+  metadata.gz: 1c26f1799992de53d2b0e4d3b949d48c5f483442
+  data.tar.gz: f7ab02ae72f18856b636c474c659cd86637580b1
 SHA512:
-  metadata.gz: 4597dad59bb5b8269d3149a91c4629a6cf1f455ea961632b6a351cdcb39a1486e5d6a264609bcce36942b9910aea1b357729e5da9116a0c4e5ddca24929fdd40
-  data.tar.gz: ae289b999a7ebdd71d3504263de80d1255aba4f38aa4c3c141fa80ee28470774793a91e55bbb0bad6c961741cbe321f55725c2140c6302c1d823b20a247d0b5a
+  metadata.gz: dcb0d482d015f5700ff7655ef927614949a0c586bfc9cbf028fc39faa91dca2e08c9dde4c6d62ffa942065895c176c7c619a92618d97a91d460dc7f970c03cb3
+  data.tar.gz: 652a0ba97e0d108ce5e5358f50f89feb3df088e433f044d52390d410ae0f4b75914af2e10a7d4936acd7cc45202d714ab8fdc569dc76b387883516e2e7009165

data/.gitignore

@@ -1 +1,2 @@
 Gemfile.lock
+pkg/*

data/README.md

@@ -6,7 +6,7 @@ A ruby interface to the Zulip API.
 
 Add this line to your application's Gemfile:
 
-`gem 'zulip-rb'`
+`gem 'zulip'`
 
 And then execute:
 
@@ -17,20 +17,17 @@ Or install it yourself as:
 `$ gem install zulip-rb`
 
 ### Configuration
-You'll need to register a bot to use the Zulip API.
 You can obtain your Zulip API key, create bots, and manage bots all
 from your Zulip [settings page](https://zulip.com/#settings).
 
-Set your api key and your bot's email address by passing a block to your Zulip::Client instance:
+Set your api key and email address by passing a block to your Zulip::Client instance:
 ```ruby
 client = Zulip::Client.new do |config|
-config.bot_email_address = "YOUR_BOTS_EMAIL_ADDRESS"
+config.email_address = "YOUR_EMAIL_ADDRESS"
 config.api_key = "YOUR_API_KEY"
 end
 ```
 
-You'll need to subscribe your bot to streams you want to read from. Do so by adding your bot's email to the stream's membership from a zulip client, or use the #subscribe method (see example below).
-
 ### Usage
 
 Send messages to a stream:
@@ -50,12 +47,12 @@ client.stream_messages do |message|
 end
 ```
 
-Get your bot's current subscriptions:
+Get your current subscriptions:
 ```ruby
 client.get_subscriptions
 ```
 
-Subscribe your bot to a stream, passing the stream name:
+Subscribe to a stream, passing the stream name:
 ```ruby
 client.subscribe "food"
 ```

data/example/zulip_message_echo.rb

@@ -7,12 +7,14 @@ class ZulipEcho
 
   def run
     client = Zulip::Client.new do |config|
-      config.bot_email_address = ENV['BOT_EMAIL_ADDRESS'] || "bot@example.com"
+      config.email_address = ENV['BOT_EMAIL_ADDRESS'] || "bot@example.com"
       config.api_key = ENV['BOT_API_KEY'] || "apikey"
     end
 
-    client.stream_messages do |message|
-      client.send_private_message(private_message_content(message), "example@gmail.com")
+    client.stream_private_messages do |message|
+      if message.stream == "test-stream"
+        client.send_private_message(private_message_content(message), "example@gmail.com")
+      end
     end
   end
 

data/lib/zulip/client.rb

@@ -17,7 +17,7 @@ module Zulip
     include Zulip::Client::EventStreaming
     include Zulip::Client::EventParser
 
-    attr_accessor :bot_email_address, :api_key
+    attr_accessor :email_address, :api_key
     attr_writer :connection
     ENDPOINT = "https://api.zulip.com"
 
@@ -33,7 +33,7 @@ module Zulip
 
     def initialize_connection
       conn = Faraday.new(url: ENDPOINT)
-      conn.basic_auth(bot_email_address, api_key)
+      conn.basic_auth(email_address, api_key)
       conn
     end
 

data/lib/zulip/client/queue_registration.rb

@@ -1,6 +1,9 @@
 module Zulip
   class Client
     module QueueRegistration
+
+      class InvalideEmailOrAPI < StandardError; end
+
       EVENT_TYPES = { message: "message" }
       # TODO: Add support for other event types
       # TODO: Add support setting apply markdown to false
@@ -13,6 +16,8 @@ module Zulip
           connection.params = { "event_types" => json_encode_list(event_types) }
         end
 
+        raise InvalideEmailOrAPI if registration_response['result'] == "error"
+
         QueueRegistrationResponse.new( registration_response['queue_id'],
                                       registration_response['last_event_id'] )
       end

data/lib/zulip/version.rb

@@ -1,3 +1,3 @@
 module Zulip
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/zulip/client/event_streaming_spec.rb

@@ -17,7 +17,7 @@ module Zulip
         let(:fake_queue) { double("fake queue", queue_id: "id", last_event_id: -1) }
 
         describe "#stream_private_messages" do
-          it "returns private messages viewable to the bot" do
+          it "returns private messages viewable to the user" do
 
             # Returns a public-message, then a private message
             fake_response.stub(:body).and_return(public_message_fixture, private_message_fixture)

data/spec/lib/zulip/client/stream_subscriptions_spec.rb

@@ -5,7 +5,7 @@ module Zulip
   class Client
     describe StreamSubscriptions do
       describe "#get_subscriptions" do
-        it "returns the bot's stream subscriptions" do
+        it "returns the user's stream subscriptions" do
           fake_http_response = double("fake http response",
                                       body: fixture("get-user-subscriptions.json"))
           fake_connection = double("fake connection", get: fake_http_response)

data/spec/lib/zulip/client/users_spec.rb

@@ -5,7 +5,7 @@ module Zulip
   class Client
     describe Users do
       describe "get_users" do
-        it "returns users in the bot's realm" do
+        it "returns a list of users" do
 
           fake_http_response = double("fake http response", body: fixture("get-users.json"))
           fake_connection = double("fake connection", get: fake_http_response)

data/spec/lib/zulip/client_spec.rb

@@ -5,11 +5,11 @@ describe Zulip::Client do
     it "yields itself upon initialization for configuration" do
 
       client = Zulip::Client.new do |config|
-        config.bot_email_address = "bot@example.com"
+        config.email_address = "bot@example.com"
         config.api_key = "apikey"
       end
 
-      expect(client.bot_email_address).to eq "bot@example.com"
+      expect(client.email_address).to eq "bot@example.com"
       expect(client.api_key).to eq "apikey"
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zulip
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryan Vergeront
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2013-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday