adn 0.3.5 → 0.3.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06ed1a97a3c6eb2616915eacbd453390e0a98b12
+  data.tar.gz: 89dbc49b0cb184307fad22cfa5490d4a31897c99
+SHA512:
+  metadata.gz: 480a7313ea2b43093fd15c8868dd960513ee2a0446c92db23bd2d86bab3eed6c646c7127822eb74d81e5db88f8d4a8be31850ce6c0ca4d68ef0541045c152e9c
+  data.tar.gz: f0d46825fbadf266d8acd5426e924b92c2f626263c91b4dc81c82af4e82dd9c7062cfc30ad80f5aceb44290dd727cb182b074355c0c51822c38b0fc5cf20ae16

data/.gitignore

@@ -2,10 +2,12 @@
 *.rbc
 .bundle
 .config
+.DS_Store
 coverage
 InstalledFiles
 lib/bundler/man
 pkg
+vendor/local
 rdoc
 spec/reports
 test/tmp

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 bundler_args: --without documentation
 rvm:
   - 1.9.3
+  - 2.0.0
 branches:
   only:
     - master

data/CHANGELOG.md

@@ -1,7 +1,9 @@
 ### Changelog
 
+* **Version 0.3.5** (11 December 2013)
+  * Added recipe for easy broadcast creation
 * **Version 0.3.5** (23 October 2012)
- * Added the unified stream
+  * Added the unified stream
 * **Version 0.3.1** (28 August 2012)  
   * Fixed naming conflict.
 * **Version 0.3** (28 August 2012)  

data/Gemfile

@@ -1,7 +1,8 @@
-source :rubygems
+source "https://rubygems.org"
+
 gemspec
 
 group :test do
   gem 'rake'
-  gem 'minitest', '~> 4.1'
+  gem 'minitest', '~> 5.1'
 end

data/Gemfile.lock

@@ -1,18 +1,18 @@
 PATH
   remote: .
   specs:
-    adn (0.3.5)
+    adn (0.3.6)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    minitest (4.1.0)
-    rake (0.9.2.2)
+    minitest (5.1.0)
+    rake (10.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   adn!
-  minitest (~> 4.1)
+  minitest (~> 5.1)
   rake

data/README.md

@@ -1,11 +1,11 @@
 ADN
 ===
 
-[![Build Status](https://secure.travis-ci.org/kishyr/ADNRuby.png)](http://travis-ci.org/kishyr/ADNRuby)
+[![Build Status](https://api.travis-ci.org/adn-rb/adn.png)](https://travis-ci.org/adn-rb/adn)
 
-A Ruby library for App.net by [@kishyr](https://alpha.app.net/kishyr). 
+A Ruby library for App.net by [@kishyr](https://alpha.app.net/kishyr).
 
-This library follows the current [App.net API Spec](https://github.com/appdotnet/api-spec) (as at 26 August 2012).  
+This library follows the current [App.net API Spec](https://github.com/appdotnet/api-spec) (as at 26 August 2012).
 
 ### Contributors
 
@@ -26,7 +26,7 @@ Or you can install ADN directly from rubygems.org:
 `gem install adn`
 
 ### Usage
-For API calls that accept parameters described in the App.net API Spec, simply pass them as a dictionary to the method.  
+For API calls that accept parameters described in the App.net API Spec, simply pass them as a dictionary to the method.
 
 ```ruby
   require 'adn'
@@ -41,7 +41,7 @@ Complete documentation will be available soon, but in the meantime you can brows
 
 ### License
 
-**ADN** is licensed under the MIT License and is Copyright (c) 2012 Kishyr Ramdial.  
+**ADN** is licensed under the MIT License and is Copyright (c) 2013 Kishyr Ramdial.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/Rakefile

@@ -14,11 +14,4 @@ task :quality do
   Bundler.with_clean_env do
     exec 'cane'
   end
-end
-
-desc "Run tests in a loop using kicker (>= 3.0.0pre1)"
-task :kicker do
-  Bundler.with_clean_env do
-    exec 'kicker --no-notification -r ruby -e "clear && rake" spec lib'
-  end
-end
+end

data/adn.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["kishyr@gmail.com", "buddhamagnet@gmail.com", "peter@c7.se"]
   s.description = "A simple and easy to use library to interact with App.net's API"
   s.summary     = "A Ruby library for App.net"
-  s.homepage    = "https://github.com/kishyr/ADNRuby"
+  s.homepage    = "https://github.com/adn-rb/adn"
   s.files       = `git ls-files`.split($\)
   s.test_files  = s.files.grep(%r{^(spec)/})
 

data/lib/adn/api/message.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+module ADN
+  module API
+    module Message
+      def self.create(channel_id, params)
+        ADN::API.post("#{ADN::API_ENDPOINT_CHANNELS}/#{channel_id}/messages", params)
+      end
+
+      def self.retrieve(channel_id, message_id)
+        ADN::API.get("#{ADN::API_ENDPOINT_CHANNELS}/#{channel_id}/messages/#{message_id}")
+      end
+
+      def self.by_id(channel_id, message_id)
+        self.retrieve(channel_id, message_id)
+      end
+
+      def self.delete(channel_id, message_id)
+        ADN::API.delete("#{ADN::API_ENDPOINT_CHANNELS}/#{channel_id}/messages/#{message_id}")
+      end
+    end
+  end
+end

data/lib/adn/api/response.rb

@@ -6,7 +6,11 @@ module ADN
   module API
     class Response < SimpleDelegator
       def has_error?
-        has_key?("error")
+        self['meta'].nil? || self['meta']['code'].nil? || self['meta']['code'] >= HTTP_ERROR
+      end
+
+      def error_message
+        self.fetch('meta').fetch('error_message')
       end
     end
   end

data/lib/adn/api.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-%w{response filter post stream subscription token user}.each do |f|
+%w{response filter post stream subscription token user message}.each do |f|
   require_relative "api/#{f}"
 end
 
@@ -14,7 +14,7 @@ module ADN
         response = JSON.parse ADN::HTTP.request(request).body
 
         Response.new(response).tap { |r|
-          raise ADN::API::Error, r['error'] if r.has_error?
+          raise ADN::API::Error, r.error_message if r.has_error?
         }
       end
 
@@ -36,13 +36,15 @@ module ADN
 
       def post(url, params = nil)
         request = construct_request(:post, url)
-        request.set_form_data(params) if params
+        request.add_field('Content-Type', 'application/json')
+        request.body = params.to_json if params
         perform(request)
       end
 
       def put(url, params = nil)
         request = construct_request(:put, url)
-        request.set_form_data(params) if params
+        request.add_field('Content-Type', 'application/json')
+        request.body = params.to_json if params
         perform(request)
       end
 

data/lib/adn/constants.rb

@@ -8,7 +8,10 @@ module ADN
   API_ENDPOINT_POSTS = "#{API_ENDPOINT}/posts"
   API_ENDPOINT_USERS = "#{API_ENDPOINT}/users"
   API_ENDPOINT_TOKEN = "#{API_ENDPOINT}/token"
+  API_ENDPOINT_CHANNELS = "#{API_ENDPOINT}/channels"
   HTTP = Net::HTTP.new(API_HOST, 443)
 
+  HTTP_ERROR = 400
+
   HTTP.use_ssl = true
 end

data/lib/adn/message.rb

@@ -0,0 +1,67 @@
+# encoding: UTF-8
+
+module ADN
+  class Message
+    attr_accessor(
+      :id, :message_id, :channel_id, :text,
+      :html, :source, :machine_only,
+      :reply_to, :thread_id,
+      :num_replies, :annotations, :entities,
+    )
+
+    attr_writer :user, :created_at
+
+    def self.send_message(params)
+      channel_id = params.delete('channel_id')
+      result = ADN::API::Message.create(channel_id, params)
+      Message.new(result["data"])
+    end
+
+    def self.by_id(channel_id, id)
+      result = ADN::API::Message.by_id(channel_id, id)
+      Message.new(result["data"])
+    end
+
+    def initialize(raw_message)
+      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
+        message_details = details
+        if message_details.has_key? "data"
+          set_values(message_details["data"])
+        end
+      end
+    end
+
+    def details
+      # 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)
+      end
+    end
+
+    def created_at
+      DateTime.parse(@created_at)
+    end
+
+    def user
+      ADN::User.new(@user)
+    end
+
+    def delete
+      result = ADN::API::Message.delete(channel_id, id)
+      ADN.create_instance(result["data"], Message)
+    end
+
+    def set_values(values)
+      values.each_pair { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+    end
+  end
+end

data/lib/adn/post.rb

@@ -9,7 +9,7 @@ module ADN
       :annotations, :entities, :you_reposted,
       :you_starred, :reposters, :starred_by
     )
-      
+
     attr_writer :user, :created_at
 
     def self.send_post(params)
@@ -17,6 +17,11 @@ module ADN
       Post.new(result["data"])
     end
 
+    def self.by_id(id)
+      result = ADN::API::Post.by_id(id)
+      Post.new(result["data"])
+    end
+
     def initialize(raw_post)
       if raw_post.respond_to?(:each_pair)
         set_values(raw_post)

data/lib/adn/recipes.rb

@@ -0,0 +1,37 @@
+# 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
+end

data/lib/adn/user.rb

@@ -8,7 +8,7 @@ module ADN
       :cover_image, :type, :counts, :app_data,
       :follows_you, :you_follow, :you_muted
     )
-      
+
     attr_writer :created_at
 
     def self.me

data/lib/adn/version.rb

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

data/lib/adn.rb

@@ -27,7 +27,9 @@ require 'uri'
 require 'json'
 require 'date'
 
-%w{constants api post user version}.each { |f| require_relative "adn/#{f}" }
+%w{constants api message post user version recipes}.each do |f|
+  require_relative "adn/#{f}"
+end
 
 module ADN
   Error = Class.new StandardError

data/spec/adn/api/message_spec.rb

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+
+require_relative '../../spec_helper'
+
+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_response) {
+    OpenStruct.new(:body => %Q{ { "meta" : {
+                            "code" : 401,
+                            "error_id" : "6f5137beac6c4b9ea8dbec8e50aa9f38$32a85f1c22e98de98ea2ddabaf76c5ae",
+                            "error_message" : "#{error_message}"
+                            }} })
+  }
+
+  describe "new" do
+    it "messages the passed in params to the API" do
+      args(:post) {
+        path, params = subject.create(1, { foo: 'bar' })
+
+        path.must_equal base_path + '/1/messages'
+        params.must_equal foo: 'bar'
+      }
+    end
+
+    it 'retrieves error message correctly' do
+      ADN::HTTP.stub(:request, error_response) do
+        error_call = lambda {subject.create(1, { 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 message" do
+      arg(:get) { subject.retrieve(8, 22).must_equal base_path + "/8/messages/22" }
+    end
+  end
+
+  describe "by_id" do
+    it "is just an alias for retrieve" do
+      subject.stub(:retrieve, 'bar') do
+        subject.by_id(4, 456).must_equal 'bar'
+      end
+    end
+  end
+
+  describe "delete" do
+    it "deletes the message" do
+      arg(:delete) { subject.delete(5, 77).must_equal base_path + "/5/messages/77" }
+    end
+  end
+end

data/spec/adn/api/post_spec.rb

@@ -6,6 +6,12 @@ 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}"
+                            }} }) }
 
   describe "new" do
     it "posts the passed in params to the API" do
@@ -16,6 +22,17 @@ describe ADN::API::Post do
         params.must_equal foo: 'bar'
       }
     end
+
+    it 'retrieves error message correctly' do
+      ADN::HTTP.stub(:request, error_response) do
+        error_call = lambda {subject.create({ 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

data/spec/adn/api/response_spec.rb

@@ -7,7 +7,7 @@ describe ADN::API::Response do
   subject { ADN::API::Response }
 
   it "currently checks a hash-like response for errors" do
-    subject.new("error" => "123").has_error?.must_equal true
-    subject.new("valid" => "123").has_error?.must_equal false
+    subject.new("meta" => {"code" => 400}).has_error?.must_equal true
+    subject.new("meta" => {"code" => 200}).has_error?.must_equal false
   end
 end

data/spec/adn/message_spec.rb

@@ -0,0 +1,124 @@
+# encoding: UTF-8
+
+require_relative '../spec_helper'
+
+def d(data)
+  { 'data' => data }
+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(:example_user) { { username: 'peterhellberg' } }
+  let(:message_data) {
+    {
+     created_at: '1999-12-31T23:59:59Z',
+     entities: {},
+     html: '<b>The sky above the port…</b>',
+     id: 10001,
+     channel_id: 65432,
+     num_replies: 1,
+     reply_to: 66,
+     source: { link: "https://alpha.app.net", name: "Alpha" },
+     text: "The sky above the port…",
+     thread_id: "301856",
+     user: example_user
+    }
+  }
+
+  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
+        m = subject.send_message({})
+        m.text.must_equal 'The sky above the port…'
+      end
+    end
+  end
+
+  describe "initialize" do
+    it "populates the accessors using the passed in hash" do
+      m = subject.new text: 'foo', id: 123, channel_id: 456
+      m.text.must_equal 'foo'
+    end
+
+    # 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
+        m = subject.new id: 123, channel_id: 456
+        m.text.must_equal 'bar'
+      end
+    end
+  end
+
+  describe "details" do
+    it "returns the details for the message" do
+      msg.details.keys.must_equal [
+        "created_at", "entities", "html",
+        "id", "channel_id", "num_replies", "reply_to",
+        "source", "text", "thread_id", "user"
+      ]
+    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' } })
+       end
+    end
+  end
+
+  describe "created_at" do
+    it "returns the date and time the message was created" do
+      msg.created_at.to_s.must_equal '1999-12-31T23:59:59+00:00'
+    end
+  end
+
+  describe "user" do
+    it "returns the user" do
+      msg.user.username.must_equal 'peterhellberg'
+    end
+  end
+
+  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::Message.stub(:delete, delete_stub) do
+        msg.delete.id.must_equal 10001
+      end
+    end
+  end
+
+  describe "set_values" do
+    it "sets values with accessors" do
+      m = empty_message
+
+      m.set_values(message_data)
+
+      m.entities.must_equal    message_data[:entities]
+      m.html.must_equal        message_data[:html]
+      m.id.must_equal          message_data[:id]
+      m.num_replies.must_equal message_data[:num_replies]
+      m.reply_to.must_equal    message_data[:reply_to]
+      m.source.must_equal      message_data[:source]
+      m.text.must_equal        message_data[:text]
+      m.thread_id.must_equal   message_data[:thread_id]
+
+      m.created_at.must_equal  DateTime.parse(message_data[:created_at])
+
+      m.user.username.must_equal message_data[:user][:username]
+    end
+
+    it "does not set arbitrary values" do
+      m = subject.new foo: 'bar'
+      -> { m.foo }.must_raise NoMethodError
+    end
+  end
+end

data/spec/adn_spec.rb

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

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
-require 'minitest/spec'
 require 'minitest/autorun'
+require 'minitest/spec'
 
 begin
   require 'minitest/pride'

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adn
 version: !ruby/object:Gem::Version
-  version: 0.3.5
-  prerelease: 
+  version: 0.3.6
 platform: ruby
 authors:
 - Kishyr Ramdial
@@ -11,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-23 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies: []
 description: A simple and easy to use library to interact with App.net's API
 email:
@@ -33,6 +32,7 @@ files:
 - lib/adn.rb
 - lib/adn/api.rb
 - lib/adn/api/filter.rb
+- lib/adn/api/message.rb
 - lib/adn/api/post.rb
 - lib/adn/api/response.rb
 - lib/adn/api/stream.rb
@@ -40,57 +40,59 @@ files:
 - lib/adn/api/token.rb
 - lib/adn/api/user.rb
 - lib/adn/constants.rb
+- lib/adn/message.rb
 - lib/adn/post.rb
+- lib/adn/recipes.rb
 - lib/adn/user.rb
 - lib/adn/version.rb
 - spec/adn/api/filter_spec.rb
+- spec/adn/api/message_spec.rb
 - spec/adn/api/post_spec.rb
 - spec/adn/api/response_spec.rb
 - spec/adn/api/stream_spec.rb
 - spec/adn/api/subscription_spec.rb
 - spec/adn/api/token_spec.rb
 - spec/adn/api/user_spec.rb
+- spec/adn/message_spec.rb
 - spec/adn/post_spec.rb
 - spec/adn/user_spec.rb
 - spec/adn_spec.rb
 - spec/fixtures/post.json
 - spec/fixtures/user.json
 - spec/spec_helper.rb
-homepage: https://github.com/kishyr/ADNRuby
+homepage: https://github.com/adn-rb/adn
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2181708405046728371
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.1.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby library for App.net
 test_files:
 - spec/adn/api/filter_spec.rb
+- spec/adn/api/message_spec.rb
 - spec/adn/api/post_spec.rb
 - spec/adn/api/response_spec.rb
 - spec/adn/api/stream_spec.rb
 - spec/adn/api/subscription_spec.rb
 - spec/adn/api/token_spec.rb
 - spec/adn/api/user_spec.rb
+- spec/adn/message_spec.rb
 - spec/adn/post_spec.rb
 - spec/adn/user_spec.rb
 - spec/adn_spec.rb