adn 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b76bc2d8bb0dbd16f14658a2f62f2c0e85aacb8
-  data.tar.gz: e347e0817b8494b9ee63f15c63635221ba196e86
+  metadata.gz: 518aadf5ddcdc8511065efd631cdba5b7116be0a
+  data.tar.gz: b7216d37b02ff2cf0b745edfd9a3a7b080dba61e
 SHA512:
-  metadata.gz: f833b54adb6692f0ad6872d63ba2dbcbf0b01c204851d9670f83da23913004c336fe5068750a1189be5a7a754e876135b43871d29178f83e6fff5138b3329085
-  data.tar.gz: 2ac0643e86d7166ed3ec9f57c243523931cad2fca878fcf0963c8cc1690235faa4a24c40e04edb2a9d84a928c3835af6687dc83b508afcbe6c8aceed5d3195f5
+  metadata.gz: 0c44e509395ec3b2288f1fa6e812d71c13c76ccaf55a4c49eda585ad0d57f9cabba6741116c03efc5ffb5c52719a3cb3bc883a7377d4db24567f3ad2fd8ba8b7
+  data.tar.gz: d30456cc7394ea2c5b017ce1a7bf36a671fb9a4282e56b5daba732cb10d31f05f2cbc2e9f0113859931dc09671e3549985e975033b72447890b094c7e67d4b91

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ### Changelog
 
+* **Version 0.3.8** (31 December 2013)
+  * Removed all style violations (cane --no-doc)
+  * Added files to broadcast builder
 * **Version 0.3.7** (15 December 2013)
   * Recipes now use the builder pattern
   * Basic file functionality
@@ -7,14 +10,14 @@
   * Added recipe for easy broadcast creation
 * **Version 0.3.5** (23 October 2012)
   * Added the unified stream
-* **Version 0.3.1** (28 August 2012)  
+* **Version 0.3.1** (28 August 2012)
   * Fixed naming conflict.
-* **Version 0.3** (28 August 2012)  
-  * Now includes a Post class that describes each post along with a bunch of new methods of accessing a post's replies and the post's original post.  
-  * Users methods that return user details (follow, unfollow, following, followers, mute, unmute, mute_list) will now return either a User object back, or an array of User objects.  
-  * Similarly, User methods that return post details (posts, mentions, stream) will return a Post object, or an array of Post objects.  
-  * To accomplish all this, I've had to change the module structure which will break existing code if you've relied on the modules to access any data. Basically, all modules begin with ADN::API:: now (eg. ADN::API::Post, ADN::API::User).  
-* **Version 0.2** (27 August 2012)  
+* **Version 0.3** (28 August 2012)
+  * Now includes a Post class that describes each post along with a bunch of new methods of accessing a post's replies and the post's original post.
+  * Users methods that return user details (follow, unfollow, following, followers, mute, unmute, mute_list) will now return either a User object back, or an array of User objects.
+  * Similarly, User methods that return post details (posts, mentions, stream) will return a Post object, or an array of Post objects.
+  * To accomplish all this, I've had to change the module structure which will break existing code if you've relied on the modules to access any data. Basically, all modules begin with ADN::API:: now (eg. ADN::API::Post, ADN::API::User).
+* **Version 0.2** (27 August 2012)
   * Changed all existing classes to modules and introduced the User class for easily accessing user details.
-* **Version 0.1** (26 August 2012)  
+* **Version 0.1** (26 August 2012)
   * Really basic functionality for all existing App.new API methods as per the spec.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adn (0.3.7)
+    adn (0.3.8)
       mime-types (~> 2.0)
       multipart-post (~> 1.2.0)
 

data/lib/adn.rb

@@ -27,7 +27,7 @@ require 'uri'
 require 'json'
 require 'date'
 
-%w{constants api message post user version recipes}.each do |f|
+%w{constants api file message post user version recipes}.each do |f|
   require_relative "adn/#{f}"
 end
 

data/lib/adn/api/file.rb

@@ -6,11 +6,17 @@ module ADN
   module API
     module File
       def self.create(filename, params)
+        string_io = StringIO.new(params.to_json)
+
+        content   = UploadIO.new(filename, MIME::Types.type_for(filename)[0])
+        metadata  = UploadIO.new(string_io, "application/json", "data")
+
         http_params = {
-          "content" => UploadIO.new(filename, MIME::Types.type_for(filename)[0]),
+          "content" => content,
           # make a fake file so we can still pass json
-          "metadata" => UploadIO.new(StringIO.new(params.to_json), "application/json", "data"),
+          "metadata" => metadata
         }
+
         ADN::API.post_multipart("#{ADN::API_ENDPOINT_FILES}", http_params)
       end
 

data/lib/adn/api/message.rb

@@ -4,11 +4,15 @@ module ADN
   module API
     module Message
       def self.create(channel_id, params)
-        ADN::API.post("#{ADN::API_ENDPOINT_CHANNELS}/#{channel_id}/messages", params)
+        path = "/#{channel_id}/messages"
+
+        ADN::API.post(ADN::API_ENDPOINT_CHANNELS + path, params)
       end
 
       def self.retrieve(channel_id, message_id)
-        ADN::API.get("#{ADN::API_ENDPOINT_CHANNELS}/#{channel_id}/messages/#{message_id}")
+        path = "/#{channel_id}/messages/#{message_id}"
+
+        ADN::API.get(ADN::API_ENDPOINT_CHANNELS + path)
       end
 
       def self.by_id(channel_id, message_id)
@@ -16,7 +20,9 @@ module ADN
       end
 
       def self.delete(channel_id, message_id)
-        ADN::API.delete("#{ADN::API_ENDPOINT_CHANNELS}/#{channel_id}/messages/#{message_id}")
+        path = "/#{channel_id}/messages/#{message_id}"
+
+        ADN::API.delete(ADN::API_ENDPOINT_CHANNELS + path)
       end
     end
   end

data/lib/adn/api/response.rb

@@ -6,7 +6,9 @@ module ADN
   module API
     class Response < SimpleDelegator
       def has_error?
-        self['meta'].nil? || self['meta']['code'].nil? || self['meta']['code'] >= HTTP_ERROR
+        self['meta'].nil? ||
+        self['meta']['code'].nil? ||
+        self['meta']['code'] >= HTTP_ERROR
       end
 
       def error_message

data/lib/adn/file.rb

@@ -2,10 +2,9 @@
 
 module ADN
   class File
-    attr_accessor(
-      :id, :file_id, :file_token, :sha1, :name, :source, :url, :kind, :total_size,
-      :url_expires, :size, :type, :public, :mime_type, :complete
-    )
+    attr_accessor :id, :file_id, :file_token, :sha1, :name, :source,
+                  :url, :kind, :total_size, :url_expires, :size,
+                  :type, :public, :mime_type, :complete
 
     attr_writer :user, :created_at
 

data/lib/adn/message.rb

@@ -26,9 +26,14 @@ module ADN
       set_values(raw_message)
       message_id = id
 
-      if raw_message.length == 2 and raw_message.key? :id and raw_message.key? :channel_id
-        # If we only have the bare minimum data, assume we want to get values from the server
+      if raw_message.length == 2 and
+        raw_message.key? :id     and
+        raw_message.key? :channel_id
+
+        # If we only have the bare minimum data,
+        # assume we want to get values from the server
         message_details = details
+
         if message_details.has_key? "data"
           set_values(message_details["data"])
         end
@@ -36,11 +41,13 @@ module ADN
     end
 
     def details
-      # if we have a source, then we've loaded stuff from the server
+      # if we have a source, then we've loaded
+      # stuff from the server
       if source
         value = self.instance_variables.map do |i|
           [i.to_s.slice(1..-1), self.instance_variable_get(i)]
         end
+
         Hash[value]
       else
         ADN::API::Message.by_id(channel_id, message_id)
@@ -61,7 +68,9 @@ module ADN
     end
 
     def set_values(values)
-      values.each_pair { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+      values.each_pair do |k, v|
+        send("#{k}=", v) if respond_to?("#{k}=")
+      end
     end
   end
 end

data/lib/adn/recipes/broadcast_message_builder.rb

@@ -3,14 +3,16 @@
 module ADN
   module Recipes
     class BroadcastMessageBuilder
-      attr_accessor(
-        :headline, :text, :read_more_link, :channel_id, :parse_links, :parse_markdown_links, :photo, :attachment
-      )
+      attr_accessor :headline, :text, :read_more_link, :channel_id,
+                    :parse_links, :parse_markdown_links, :photo, :attachment
 
       def initialize(params = {})
         if params.respond_to? :each_pair
-          params.each_pair { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+          params.each_pair do |k, v|
+            send("#{k}=", v) if respond_to?("#{k}=")
+          end
         end
+
         yield self if block_given?
       end
 
@@ -33,23 +35,68 @@ module ADN
           }
         end
 
+        if self.photo
+          file = ADN::File.upload_file(self.photo, {
+            type: 'net.app.adnrb.upload'
+          })
+
+
+          annotations << {
+            type: 'net.app.core.oembed',
+            value: {
+              "+net.app.core.file" => {
+                file_id: file.id,
+                file_token: file.file_token,
+                format: 'oembed',
+              }
+            }
+          }
+        end
+
+        if self.attachment
+          file = ADN::File.upload_file(self.attachment, {
+            type: 'net.app.adnrb.upload'
+          })
+
+          annotations << {
+            type: 'net.app.core.attachments',
+            value: {
+              "+net.app.core.file_list" => [
+                {
+                  file_id: file.id,
+                  file_token: file.file_token,
+                  format: 'metadata',
+                }
+              ]
+            }
+          }
+        end
+
         annotations
       end
 
       def message
-        {
+        message = {
           annotations: self.annotations,
-          text: self.text,
-          machine_only: (not self.text),
           entities: {
-            parse_links: (self.parse_links or self.parse_markdown_links),
+            parse_links: !!(self.parse_links or self.parse_markdown_links),
             parse_markdown_links: !!self.parse_markdown_links
           }
         }
+
+        if self.text
+          message[:text] = self.text
+        else
+          message[:machine_only] = true
+        end
+
+        message
       end
 
       def send
-        Message.new ADN::API::Message.create(self.channel_id, self.message)["data"]
+        api_message = ADN::API::Message.create(self.channel_id, self.message)
+
+        Message.new api_message["data"]
       end
     end
   end

data/lib/adn/version.rb

@@ -3,7 +3,7 @@
 module ADN
   MAJOR = 0
   MINOR = 3
-  TINY  = 7
+  TINY  = 8
   VERSION = [MAJOR, MINOR, TINY].join('.')
 end
 

data/spec/adn/api/file_spec.rb

@@ -6,17 +6,25 @@ describe ADN::API::File do
   subject { ADN::API::File }
 
   let(:base_path) { '/stream/0/files' }
-  let(:error_message) {
-    'Call requires authentication: This view requires authentication and no token was provided.'
-  }
 
-  let(:error_response) {
-    OpenStruct.new(:body => %Q{ { "meta" : {
-                            "code" : 401,
-                            "error_id" : "6f5137beac6c4b9ea8dbec8e50aa9f38$32a85f1c22e98de98ea2ddabaf76c5ae",
-                            "error_message" : "#{error_message}"
-                            }} })
-  }
+  let(:error_id) do
+    '6f5137beac6c4b9ea8dbec8e50aa9f38$32a85f1c22e98de98ea2ddabaf76c5ae'
+  end
+
+  let(:error_message) do
+    'Call requires authentication: This view requires' +
+    ' authentication and no token was provided.'
+  end
+
+  let(:error_response) do
+    OpenStruct.new(:body => %Q{ {
+      "meta" : {
+        "code" : 401,
+        "error_id" : "#{error_id}",
+        "error_message" : "#{error_message}"
+      }}
+    })
+  end
 
   describe "new" do
     it "passes the file content in params to the API" do
@@ -27,6 +35,7 @@ describe ADN::API::File do
         params["content"].local_path.must_equal __FILE__
         params["content"].content_type.must_equal "application/x-ruby"
         params["metadata"].content_type.must_equal "application/json"
+
         JSON.parse(params["metadata"].read).must_equal({"type" => 'foo'})
       }
     end

data/spec/adn/api/message_spec.rb

@@ -6,16 +6,24 @@ describe ADN::API::Message do
   subject { ADN::API::Message }
 
   let(:base_path) { '/stream/0/channels' }
-  let(:error_message) {
-    'Call requires authentication: This view requires authentication and no token was provided.'
-  }
+
+  let(:error_id) do
+    '6f5137beac6c4b9ea8dbec8e50aa9f38$32a85f1c22e98de98ea2ddabaf76c5ae'
+  end
+
+  let(:error_message) do
+    'Call requires authentication: This view requires' +
+    ' authentication and no token was provided.'
+  end
 
   let(:error_response) {
-    OpenStruct.new(:body => %Q{ { "meta" : {
-                            "code" : 401,
-                            "error_id" : "6f5137beac6c4b9ea8dbec8e50aa9f38$32a85f1c22e98de98ea2ddabaf76c5ae",
-                            "error_message" : "#{error_message}"
-                            }} })
+    OpenStruct.new(:body =>
+      %Q{ { "meta" : {
+            "code" : 401,
+            "error_id" : "#{error_id}",
+            "error_message" : "#{error_message}"
+      }}
+    })
   }
 
   describe "new" do
@@ -41,7 +49,9 @@ describe ADN::API::Message do
 
   describe "retrieve" do
     it "retrieves the message" do
-      arg(:get) { subject.retrieve(8, 22).must_equal base_path + "/8/messages/22" }
+      arg(:get) {
+        subject.retrieve(8, 22).must_equal base_path + "/8/messages/22"
+      }
     end
   end
 
@@ -55,7 +65,9 @@ describe ADN::API::Message do
 
   describe "delete" do
     it "deletes the message" do
-      arg(:delete) { subject.delete(5, 77).must_equal base_path + "/5/messages/77" }
+      arg(:delete) {
+        subject.delete(5, 77).must_equal base_path + "/5/messages/77"
+      }
     end
   end
 end

data/spec/adn/api/post_spec.rb

@@ -6,12 +6,25 @@ describe ADN::API::Post do
   subject { ADN::API::Post }
 
   let(:base_path) { '/stream/0/posts' }
-  let(:error_message) {'Call requires authentication: This view requires authentication and no token was provided.'}
-  let(:error_response) { OpenStruct.new(:body => %Q{ { "meta" : {
-                            "code" : 401,
-                            "error_id" : "6f5137beac6c4b9ea8dbec8e50aa9f38$32a85f1c22e98de98ea2ddabaf76c5ae",
-                            "error_message" : "#{error_message}"
-                            }} }) }
+
+  let(:error_message) do
+    'Call requires authentication: This view requires' +
+    ' authentication and no token was provided.'
+  end
+
+  let(:error_id) do
+    "6f5137beac6c4b9ea8dbec8e50aa9f38$32a85f1c22e98de98ea2ddabaf76c5ae"
+  end
+
+  let(:error_response) do
+    OpenStruct.new(:body => %Q{ {
+      "meta" : {
+        "code" : 401,
+        "error_id" : "#{error_id}",
+        "error_message" : "#{error_message}"
+      }}
+    })
+  end
 
   describe "new" do
     it "posts the passed in params to the API" do
@@ -32,12 +45,13 @@ describe ADN::API::Post do
         error.message.must_equal error_message
       end
     end
-
   end
 
   describe "retrieve" do
     it "retrieves the post" do
-      arg(:get) { subject.retrieve(22).must_equal base_path + "/22" }
+      arg(:get) {
+        subject.retrieve(22).must_equal base_path + "/22"
+      }
     end
   end
 
@@ -51,7 +65,9 @@ describe ADN::API::Post do
 
   describe "delete" do
     it "deletes the post" do
-      arg(:delete) { subject.delete(77).must_equal base_path + "/77" }
+      arg(:delete) {
+        subject.delete(77).must_equal base_path + "/77"
+      }
     end
   end
 

data/spec/adn/file_spec.rb

@@ -57,8 +57,22 @@ describe ADN::File do
   describe "details" do
     it "returns the details for the file" do
       file.details.keys.must_equal [
-        "created_at", "id", "user", "file_token", "sha1", "name", "source", "url", "kind", "total_size",
-        "url_expires", "size", "type", "public", "mime_type", "complete"
+        "created_at",
+        "id",
+        "user",
+        "file_token",
+        "sha1",
+        "name",
+        "source",
+        "url",
+        "kind",
+        "total_size",
+        "url_expires",
+        "size",
+        "type",
+        "public",
+        "mime_type",
+        "complete"
       ]
     end
   end

data/spec/adn/message_spec.rb

@@ -9,11 +9,27 @@ end
 describe ADN::Message do
   subject { ADN::Message }
 
-  let(:empty_message) { subject.new({}) }
-  let(:message_with_id) { subject.new({ channel_id: '456', message_id: '123' }) }
-  let(:msg) { subject.new(message_data) }
+  let(:empty_message) do
+    subject.new({})
+  end
+
+  let(:message_with_id) do
+    subject.new({
+      channel_id: '456',
+      message_id: '123'
+    })
+  end
+
+  let(:msg) do
+    subject.new(message_data)
+  end
+
+  let(:example_user) do
+    {
+      username: 'peterhellberg'
+    }
+  end
 
-  let(:example_user) { { username: 'peterhellberg' } }
   let(:message_data) {
     {
      created_at: '1999-12-31T23:59:59Z',
@@ -32,7 +48,9 @@ describe ADN::Message do
 
   describe "send_message" do
     it "creates a message via the API" do
-      ADN::API::Message.stub(:create, ADN::API::Response.new(d(message_data))) do
+      api_response = ADN::API::Response.new(d(message_data))
+
+      ADN::API::Message.stub(:create, api_response) do
         m = subject.send_message({})
         m.text.must_equal 'The sky above the port…'
       end
@@ -47,7 +65,9 @@ describe ADN::Message do
 
     # TODO: Change this behavior (Add a find method instead)
     it "populates the accessors based on the passed in id" do
-      ADN::API::Message.stub(:by_id, ->(c_id, i){ d({ "text" => 'bar'}) }) do
+      by_id = ->(c_id, i){ d({ "text" => 'bar'}) }
+
+      ADN::API::Message.stub(:by_id, by_id) do
         m = subject.new id: 123, channel_id: 456
         m.text.must_equal 'bar'
       end
@@ -64,10 +84,15 @@ describe ADN::Message do
     end
 
     it "returns the message from the api if it has no id" do
-
-       ADN::API::Message.stub(:by_id, ->(c_id, i){ d({ "id" => i, "channel_id" => c_id}) }) do
-         message_with_id.details.
-           must_equal({ "data" => { "id" => '123', "channel_id" => '456' } })
+      by_id = ->(c_id, i){ d({ "id" => i, "channel_id" => c_id}) }
+
+      ADN::API::Message.stub(:by_id, by_id) do
+        message_with_id.details.must_equal({
+          "data" => {
+            "id" => '123',
+            "channel_id" => '456'
+          }
+        })
        end
     end
   end
@@ -87,7 +112,10 @@ describe ADN::Message do
   describe "delete" do
     it "deletes the message via the API and returns the message" do
       delete_stub = ->(c_id, id){
-        ADN::API::Response.new("data" => { "channel_id" => c_id, "id" => id })
+        ADN::API::Response.new("data" => {
+          "channel_id" => c_id,
+          "id" => id
+        })
       }
 
       ADN::API::Message.stub(:delete, delete_stub) do

data/spec/adn/recipes/broadcast_message_builder_spec.rb

@@ -34,6 +34,68 @@ describe ADN::Recipes::BroadcastMessageBuilder do
         ])
       end
     end
+
+    describe "with a photo" do
+      it "generates an oembed annotation" do
+        api_response = ADN::API::Response.new({
+          "data" => {
+            id: "1",
+            file_token: "1234"
+          }
+        })
+
+        ADN::API::File.stub(:create, api_response) do
+          subject.headline = "foo"
+          subject.photo = "foo.jpg"
+          subject.annotations.must_equal([
+            {
+              type: "net.app.core.broadcast.message.metadata",
+              value: { subject: "foo" }
+            },
+            {
+              type: "net.app.core.oembed",
+              value: { "+net.app.core.file" => {
+                file_id: "1",
+                file_token: "1234",
+                format: "oembed"
+              }}
+            }
+          ])
+        end
+      end
+    end
+
+    describe "with an attachment" do
+      it "generates an attachment annotation" do
+        api_response = ADN::API::Response.new({
+          "data" => {
+            id: "1",
+            file_token: "1234"
+          }
+        })
+
+        ADN::API::File.stub(:create, api_response) do
+          subject.headline = "foo"
+          subject.attachment = "foo.txt"
+          subject.annotations.must_equal([
+            {
+              type: "net.app.core.broadcast.message.metadata",
+              value: { subject: "foo" }
+            },
+            {
+              type: "net.app.core.attachments",
+              value: { "+net.app.core.file_list" => [
+                {
+                  file_id: "1",
+                  file_token: "1234",
+                  format: "metadata"
+                }
+              ]}
+            }
+          ])
+        end
+      end
+    end
   end
 
   describe "message" do
@@ -42,7 +104,7 @@ describe ADN::Recipes::BroadcastMessageBuilder do
         subject.headline = "foo"
         subject.text = "bar"
         subject.message[:text].must_equal("bar")
-        subject.message[:machine_only].must_equal(false)
+        subject.message[:machine_only].must_equal(nil)
       end
     end
 
@@ -52,6 +114,7 @@ describe ADN::Recipes::BroadcastMessageBuilder do
         subject.message[:text].must_be_nil
         subject.message[:machine_only].must_equal(true)
       end
+
       it "includes the annotations" do
         subject.headline = "bar"
         subject.message[:annotations].must_equal([
@@ -100,6 +163,7 @@ describe ADN::Recipes::BroadcastMessageBuilder do
           "channel_id": "#{channel_id}"
         }
       }}
+
       response = OpenStruct.new(:body => response_body)
 
       ADN::HTTP.stub(:request, response) do

data/spec/adn_spec.rb

@@ -19,7 +19,7 @@ describe ADN do
     ADN::API_HOST.must_equal 'alpha-api.app.net'
   end
 
-  it "has constants containing the API endpoints for posts, users, channels, and files" do
+  it "has constants for the API endpoints posts, users, channels, and files" do
     ADN::API_ENDPOINT_POSTS.must_equal '/stream/0/posts'
     ADN::API_ENDPOINT_USERS.must_equal '/stream/0/users'
     ADN::API_ENDPOINT_CHANNELS.must_equal '/stream/0/channels'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adn
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Kishyr Ramdial
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-15 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post