adn 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06ed1a97a3c6eb2616915eacbd453390e0a98b12
-  data.tar.gz: 89dbc49b0cb184307fad22cfa5490d4a31897c99
+  metadata.gz: 1b76bc2d8bb0dbd16f14658a2f62f2c0e85aacb8
+  data.tar.gz: e347e0817b8494b9ee63f15c63635221ba196e86
 SHA512:
-  metadata.gz: 480a7313ea2b43093fd15c8868dd960513ee2a0446c92db23bd2d86bab3eed6c646c7127822eb74d81e5db88f8d4a8be31850ce6c0ca4d68ef0541045c152e9c
-  data.tar.gz: f0d46825fbadf266d8acd5426e924b92c2f626263c91b4dc81c82af4e82dd9c7062cfc30ad80f5aceb44290dd727cb182b074355c0c51822c38b0fc5cf20ae16
+  metadata.gz: f833b54adb6692f0ad6872d63ba2dbcbf0b01c204851d9670f83da23913004c336fe5068750a1189be5a7a754e876135b43871d29178f83e6fff5138b3329085
+  data.tar.gz: 2ac0643e86d7166ed3ec9f57c243523931cad2fca878fcf0963c8cc1690235faa4a24c40e04edb2a9d84a928c3835af6687dc83b508afcbe6c8aceed5d3195f5

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 ### Changelog
 
-* **Version 0.3.5** (11 December 2013)
+* **Version 0.3.7** (15 December 2013)
+  * Recipes now use the builder pattern
+  * Basic file functionality
+* **Version 0.3.6** (11 December 2013)
   * Added recipe for easy broadcast creation
 * **Version 0.3.5** (23 October 2012)
   * Added the unified stream

data/Gemfile.lock

@@ -1,12 +1,16 @@
 PATH
   remote: .
   specs:
-    adn (0.3.6)
+    adn (0.3.7)
+      mime-types (~> 2.0)
+      multipart-post (~> 1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    mime-types (2.0)
     minitest (5.1.0)
+    multipart-post (1.2.0)
     rake (10.1.0)
 
 PLATFORMS

data/adn.gemspec

@@ -13,5 +13,7 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split($\)
   s.test_files  = s.files.grep(%r{^(spec)/})
 
+  s.add_runtime_dependency "multipart-post", ["~> 1.2.0"]
+  s.add_runtime_dependency "mime-types", ["~> 2.0"]
   s.required_ruby_version = '>= 1.9.3'
 end

data/lib/adn/api/file.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+require 'mime/types'
+require 'net/http/post/multipart'
+
+module ADN
+  module API
+    module File
+      def self.create(filename, params)
+        http_params = {
+          "content" => UploadIO.new(filename, MIME::Types.type_for(filename)[0]),
+          # make a fake file so we can still pass json
+          "metadata" => UploadIO.new(StringIO.new(params.to_json), "application/json", "data"),
+        }
+        ADN::API.post_multipart("#{ADN::API_ENDPOINT_FILES}", http_params)
+      end
+
+      def self.retrieve(file_id)
+        ADN::API.get("#{ADN::API_ENDPOINT_FILES}/#{file_id}")
+      end
+
+      def self.by_id(file_id)
+        self.retrieve(file_id)
+      end
+
+      def self.delete(file_id)
+        ADN::API.delete("#{ADN::API_ENDPOINT_FILES}/#{file_id}")
+      end
+    end
+  end
+end

data/lib/adn/api.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-%w{response filter post stream subscription token user message}.each do |f|
+%w{response filter post stream subscription token user message file}.each do |f|
   require_relative "api/#{f}"
 end
 
@@ -41,6 +41,11 @@ module ADN
         perform(request)
       end
 
+      def post_multipart(url, *http_args)
+        request = Net::HTTP::Post::Multipart.new(url, *http_args)
+        perform(request)
+      end
+
       def put(url, params = nil)
         request = construct_request(:put, url)
         request.add_field('Content-Type', 'application/json')

data/lib/adn/constants.rb

@@ -9,6 +9,7 @@ module ADN
   API_ENDPOINT_USERS = "#{API_ENDPOINT}/users"
   API_ENDPOINT_TOKEN = "#{API_ENDPOINT}/token"
   API_ENDPOINT_CHANNELS = "#{API_ENDPOINT}/channels"
+  API_ENDPOINT_FILES = "#{API_ENDPOINT}/files"
   HTTP = Net::HTTP.new(API_HOST, 443)
 
   HTTP_ERROR = 400

data/lib/adn/file.rb

@@ -0,0 +1,63 @@
+# encoding: UTF-8
+
+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_writer :user, :created_at
+
+    def self.upload_file(filename, params)
+      result = ADN::API::File.create(filename, params)
+      File.new(result["data"])
+    end
+
+    def self.by_id(id)
+      result = ADN::API::File.by_id(id)
+      File.new(result["data"])
+    end
+
+    def initialize(raw_file)
+      if raw_file.respond_to?(:each_pair)
+        set_values(raw_file)
+        file_id = id
+      else
+        file_id = raw_file
+        file_details = details
+        if file_details.has_key? "data"
+          set_values(file_details["data"])
+        end
+      end
+    end
+
+    def details
+      if id
+        value = self.instance_variables.map do |i|
+          [i.to_s.slice(1..-1), self.instance_variable_get(i)]
+        end
+        Hash[value]
+      else
+        ADN::API::File.by_id(file_id)
+      end
+    end
+
+    def created_at
+      DateTime.parse(@created_at)
+    end
+
+    def user
+      ADN::User.new(@user)
+    end
+
+    def delete
+      result = ADN::API::File.delete(id)
+      ADN.create_instance(result["data"], File)
+    end
+
+    def set_values(values)
+      values.each_pair { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+    end
+  end
+end

data/lib/adn/recipes/broadcast_message_builder.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+
+module ADN
+  module Recipes
+    class BroadcastMessageBuilder
+      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}=") }
+        end
+        yield self if block_given?
+      end
+
+      def annotations
+        annotations = [
+          {
+            type: 'net.app.core.broadcast.message.metadata',
+            value: {
+              subject: self.headline
+            }
+          }
+        ]
+
+        if self.read_more_link
+          annotations << {
+            type: 'net.app.core.crosspost',
+            value: {
+              canonical_url: self.read_more_link
+            }
+          }
+        end
+
+        annotations
+      end
+
+      def message
+        {
+          annotations: self.annotations,
+          text: self.text,
+          machine_only: (not self.text),
+          entities: {
+            parse_links: (self.parse_links or self.parse_markdown_links),
+            parse_markdown_links: !!self.parse_markdown_links
+          }
+        }
+      end
+
+      def send
+        Message.new ADN::API::Message.create(self.channel_id, self.message)["data"]
+      end
+    end
+  end
+end

data/lib/adn/recipes.rb

@@ -1,37 +1,5 @@
 # encoding: UTF-8
 
-module ADN
-  module Recipes
-    def self.send_broadcast(params)
-      channel_id = params.delete('channel_id')
-      broadcast = params.delete('broadcast')
-      text = params.delete('text')
-      read_more_link = params.delete('read_more_link')
-
-      message = {
-        annotations: [
-          {
-            type: 'net.app.core.broadcast.message.metadata',
-            value: {
-              subject: broadcast
-            }
-          }
-        ],
-        text: text,
-        machine_only: (not text)
-      }
-
-      if read_more_link
-        message[:annotations] << {
-          type: 'net.app.core.crosspost',
-          value: {
-            canonical_url: read_more_link
-          }
-        }
-      end
-
-      result = ADN::API::Message.create(channel_id, message)
-      Message.new(result["data"])
-    end
-  end
+%w{broadcast_message_builder}.each do |f|
+  require_relative "recipes/#{f}"
 end

data/lib/adn/version.rb

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

data/spec/adn/api/file_spec.rb

@@ -0,0 +1,64 @@
+# encoding: UTF-8
+
+require_relative '../../spec_helper'
+
+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}"
+                            }} })
+  }
+
+  describe "new" do
+    it "passes the file content in params to the API" do
+      args(:post_multipart) {
+        path, params = subject.create(__FILE__, { type: 'foo' })
+
+        path.must_equal base_path
+        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
+
+    it 'retrieves error message correctly' do
+      ADN::HTTP.stub(:request, error_response) do
+        error_call = lambda {subject.create(__FILE__, { foo: 'bar' })}
+        error_call.must_raise ADN::API::Error
+
+        error = error_call.call rescue $!
+        error.message.must_equal error_message
+      end
+    end
+  end
+
+  describe "retrieve" do
+    it "retrieves the file" do
+      arg(:get) { subject.retrieve(8).must_equal base_path + "/8" }
+    end
+  end
+
+  describe "by_id" do
+    it "is just an alias for retrieve" do
+      subject.stub(:retrieve, 'bar') do
+        subject.by_id(4).must_equal 'bar'
+      end
+    end
+  end
+
+  describe "delete" do
+    it "deletes the file" do
+      arg(:delete) { subject.delete(5).must_equal base_path + "/5" }
+    end
+  end
+end

data/spec/adn/file_spec.rb

@@ -0,0 +1,89 @@
+# encoding: UTF-8
+
+require_relative '../spec_helper'
+
+def d(data)
+  { 'data' => data }
+end
+
+describe ADN::File do
+  subject { ADN::File }
+
+  let(:file)       { subject.new(file_data) }
+  let(:example_user) { { username: 'peterhellberg' } }
+  let(:file_data) {{
+    created_at: '1999-12-31T23:59:59Z',
+    id: 10001,
+    user: example_user,
+    file_token: "abc123",
+    sha1: "d5e7c7a123108739a28d721eb34133600a70a7fa",
+    name: "foo.txt",
+    source: { link: "https://alpha.app.net", name: "Alpha" },
+    url: "https://adn-uf-01.s3.amazonaws.com/adn-uf-01/really_long_filepath",
+    kind: "other",
+    total_size: 2248,
+    url_expires: "2013-12-14T02:00:00Z",
+    size: 2248,
+    type: "net.app.testing",
+    public: false,
+    mime_type: "text/plain",
+    complete: true
+  }}
+
+  describe "upload_file" do
+    it "creates a message via the API" do
+      ADN::API::File.stub(:create, ADN::API::Response.new(d(file_data))) do
+        m = subject.upload_file("foo.txt", {type: "net.app.testing"})
+        m.type.must_equal 'net.app.testing'
+        m.name.must_equal 'foo.txt'
+      end
+    end
+  end
+
+  describe "initialize" do
+    it "populates the accessors using the passed in hash" do
+      m = subject.new id: 123
+      m.id.must_equal 123
+    end
+
+    it "populates the accessors based on the passed in id" do
+      ADN::API::File.stub(:by_id, ->(i){ d({ "total_size" => 1234}) }) do
+        f = subject.new 123
+        f.total_size.must_equal 1234
+      end
+    end
+  end
+
+  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"
+      ]
+    end
+  end
+
+  describe "created_at" do
+    it "returns the date and time the message was created" do
+      file.created_at.to_s.must_equal '1999-12-31T23:59:59+00:00'
+    end
+  end
+
+  describe "user" do
+    it "returns the user" do
+      file.user.username.must_equal 'peterhellberg'
+    end
+  end
+
+  describe "delete" do
+    it "deletes the file via the API and returns the file" do
+      delete_stub = ->(id){
+        ADN::API::Response.new("data" => { "id" => id })
+      }
+
+      ADN::API::File.stub(:delete, delete_stub) do
+        file.delete.id.must_equal 10001
+      end
+    end
+  end
+end

data/spec/adn/recipes/broadcast_message_builder_spec.rb

@@ -0,0 +1,115 @@
+# encoding: UTF-8
+
+require_relative '../../spec_helper'
+
+describe ADN::Recipes::BroadcastMessageBuilder do
+  subject { ADN::Recipes::BroadcastMessageBuilder.new }
+
+  describe "annotations" do
+    describe "with a read more link" do
+      it "generates a crosspost annotation" do
+        subject.headline = "foo"
+        subject.read_more_link = "http://app.net"
+        subject.annotations.must_equal([
+          {
+            type: "net.app.core.broadcast.message.metadata",
+            value: { subject: "foo" }
+          },
+          {
+            type: "net.app.core.crosspost",
+            value: { canonical_url: "http://app.net" }
+          }
+        ])
+      end
+    end
+
+    describe "with only a headline" do
+      it "generates a message metadata annotation" do
+        subject.headline = "foo"
+        subject.annotations.must_equal([
+          {
+            type: "net.app.core.broadcast.message.metadata",
+            value: { subject: "foo" }
+          },
+        ])
+      end
+    end
+  end
+
+  describe "message" do
+    describe "with text" do
+      it "includes the extra text" do
+        subject.headline = "foo"
+        subject.text = "bar"
+        subject.message[:text].must_equal("bar")
+        subject.message[:machine_only].must_equal(false)
+      end
+    end
+
+    describe "without text" do
+      it "generates a machine only message" do
+        subject.headline = "foo"
+        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([
+          {
+            type: "net.app.core.broadcast.message.metadata",
+            value: { subject: "bar" }
+          },
+        ])
+      end
+    end
+
+    it "allows you to parse links" do
+      subject.headline = "foo"
+      subject.parse_links = true
+      subject.message[:entities].must_equal({
+        parse_links: true,
+        parse_markdown_links: false
+      })
+    end
+
+    it "parses links when you ask for parsing markdown links" do
+      subject.headline = "foo"
+      subject.parse_markdown_links = true
+      subject.message[:entities].must_equal({
+        parse_links: true,
+        parse_markdown_links: true
+      })
+    end
+  end
+
+  describe "send" do
+    it "calls the api with the message" do
+      headline = "foo"
+      channel_id = "123"
+      response_body = %Q{{
+        "meta": {
+          "code": 200
+        },
+        "data": {
+          "annotations": [
+            {
+              "type": "net.app.core.broadcast.message.metadata",
+              "value": {"subject": "#{headline}"}
+            }
+          ],
+          "channel_id": "#{channel_id}"
+        }
+      }}
+      response = OpenStruct.new(:body => response_body)
+
+      ADN::HTTP.stub(:request, response) do
+        subject.headline = headline
+        subject.channel_id = channel_id
+
+        message = subject.send
+        message.channel_id.must_equal channel_id
+        message.annotations[0]["value"]["subject"].must_equal headline
+      end
+    end
+  end
+end

data/spec/adn_spec.rb

@@ -19,10 +19,11 @@ describe ADN do
     ADN::API_HOST.must_equal 'alpha-api.app.net'
   end
 
-  it "has constants containing the API endpoints for posts, users, and channels" do
+  it "has constants containing the API endpoints for 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'
+    ADN::API_ENDPOINT_FILES.must_equal '/stream/0/files'
   end
 
   it "has constants containing the API endpoints for tokens" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adn
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Kishyr Ramdial
@@ -10,8 +10,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
-dependencies: []
+date: 2013-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: A simple and easy to use library to interact with App.net's API
 email:
 - kishyr@gmail.com
@@ -31,6 +59,7 @@ files:
 - adn.gemspec
 - lib/adn.rb
 - lib/adn/api.rb
+- lib/adn/api/file.rb
 - lib/adn/api/filter.rb
 - lib/adn/api/message.rb
 - lib/adn/api/post.rb
@@ -40,11 +69,14 @@ files:
 - lib/adn/api/token.rb
 - lib/adn/api/user.rb
 - lib/adn/constants.rb
+- lib/adn/file.rb
 - lib/adn/message.rb
 - lib/adn/post.rb
 - lib/adn/recipes.rb
+- lib/adn/recipes/broadcast_message_builder.rb
 - lib/adn/user.rb
 - lib/adn/version.rb
+- spec/adn/api/file_spec.rb
 - spec/adn/api/filter_spec.rb
 - spec/adn/api/message_spec.rb
 - spec/adn/api/post_spec.rb
@@ -53,8 +85,10 @@ files:
 - spec/adn/api/subscription_spec.rb
 - spec/adn/api/token_spec.rb
 - spec/adn/api/user_spec.rb
+- spec/adn/file_spec.rb
 - spec/adn/message_spec.rb
 - spec/adn/post_spec.rb
+- spec/adn/recipes/broadcast_message_builder_spec.rb
 - spec/adn/user_spec.rb
 - spec/adn_spec.rb
 - spec/fixtures/post.json
@@ -84,6 +118,7 @@ signing_key:
 specification_version: 4
 summary: A Ruby library for App.net
 test_files:
+- spec/adn/api/file_spec.rb
 - spec/adn/api/filter_spec.rb
 - spec/adn/api/message_spec.rb
 - spec/adn/api/post_spec.rb
@@ -92,8 +127,10 @@ test_files:
 - spec/adn/api/subscription_spec.rb
 - spec/adn/api/token_spec.rb
 - spec/adn/api/user_spec.rb
+- spec/adn/file_spec.rb
 - spec/adn/message_spec.rb
 - spec/adn/post_spec.rb
+- spec/adn/recipes/broadcast_message_builder_spec.rb
 - spec/adn/user_spec.rb
 - spec/adn_spec.rb
 - spec/fixtures/post.json