washbullet 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cb3c774ded8d13781c34ebb0679f6f028aecd32
-  data.tar.gz: 38d52e341ca5f16617249780224b0c12281befc5
+  metadata.gz: 04b00def53d0001c2857430d0125e2804e39c4cb
+  data.tar.gz: 18d2a8debae29e33f43d02e02b3668110cfe61f2
 SHA512:
-  metadata.gz: 08844feca60a92007c068d504b1656d1e547e42aafdd3a1c1ac7c6e4f162e32404cbe8fdb205073228fe8358bb1f2caa6efa3dc67c61011600d445ea04a546f6
-  data.tar.gz: 5e6b593a93445ef4c19f00f8e69b5bcefd42b0543af804ad4acbb24d0b5507e1e6fa113a20c3a24806af53ad88a1077ed97d4122b488adb643985695953e32cf
+  metadata.gz: e332376572793ddc8ed5f411f921d77c73bbfef5c40275d0ba653cdb266eee6cfaf26fe93bb7d7c5b08d43a951782f8f4a2929b9c011dc505d0c77450b270e5a
+  data.tar.gz: efc87efe004731cd662c6599652dc2e25bc798bd5106615b2fd55edb7cd19bc4b21b97d23b245ada80ccdf7d1db04eb40f57198767ed894f41e3dd7cdb3a269e

data/.gitignore

@@ -3,6 +3,8 @@
 .bundle
 .config
 .yardoc
+.gems
+.rbenv-gemsets
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -15,3 +17,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.envrc

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format progress
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/README.md

@@ -1,5 +1,7 @@
 # Washbullet
 
+[![Build Status](https://travis-ci.org/hrysd/washbullet.svg?branch=master)](https://travis-ci.org/hrysd/washbullet)
+
 Ruby client of [Pushbullet](https://www.pushbullet.com/).
 
 ## Installation
@@ -10,51 +12,86 @@ $ gem install washbullet
 
 ## Usage
 
-#### Setup Client
+### Setup Client
 
 ```ruby
 client = Washbullet::Client.new('YOUR_API_KEY')
 ```
 
-#### Push to own device
+### Push
 
 You can send following list:
+
 - note
 - link
-- address
-- list
 - file
 
 ```ruby
-# Get own device list
-client.devices
-
-# note
-client.push_note(device_iden, 'Title of note', 'A note\'s content')
-
-# link
-client.push_link(device_iden, 'Title of link', 'https://www.pushbullet.com', 'This website is awesome.')
+client.push_note(
+  receiver:   :device, # :email, :channel, :client
+  identifier: '<IDENTIFIER>',
+  params: {
+    title: 'Title',
+    body:  'Contents'
+  }
+)
+```
 
-# address
-client.push_address(device_iden, 'Name of address', 'Addrss of place')
+### Devices
 
-# list
-client.push_list(device_iden, 'Title of lists', [{text: 'Buy milk', checked: true}, {text: 'Buy Soy milk', checked: false}])
+```ruby
+# Get own active devices
+client.devices
+```
 
-# file
-client.push_file(device_iden, 'File name', 'path/to/file', 'An optional message')
+### Contacts
 
-# Get friend list of Pushbullet
+```ruby
+# Get friends list
 client.contacts
+```
 
-# Get self info
+### Get self info
+
+```
 client.me
 ```
 
-## TODO
-
-- push friend's device
-- test...
+## Supported API
+
+detail: https://docs.pushbullet.com/
+
+**Pushes**
+  - [X] Push to device
+  - [ ] Request push history
+  - [ ] Update a push
+  - [ ] Deleting a push
+  - [ ] Deleting all pushes
+
+**Devices**
+  - [X] Get the devices that can be pushed to
+  - [ ] Create a new device
+  - [ ] Update an existing device
+  - [ ] Delete a device
+
+**Contacts**
+  - [X] Get your contacts
+  - [ ] Create a contact
+  - [ ] Update a contact
+  - [ ] Delete a contact
+
+**Subscriptions**
+  - [ ] Subscribe to a channel
+  - [X] List subscriptions
+  - [ ] Unsubscribe from a channel
+  - [X] Get information about a channel
+
+**Users**
+  - [X] Get the current user
+  - [ ] Update the current user
+
+**Realtime Event Stream**
+  - Not yet
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/washbullet.rb

@@ -1,4 +1,9 @@
 require 'washbullet/client'
+require 'washbullet/pushable'
+require 'washbullet/channel'
+require 'washbullet/contact'
+require 'washbullet/device'
+require 'washbullet/user'
 
 module Washbullet
 end

data/lib/washbullet/api.rb

@@ -1,7 +1,8 @@
 require 'washbullet/api/contacts'
 require 'washbullet/api/devices'
-require 'washbullet/api/pushes'
 require 'washbullet/api/me'
+require 'washbullet/api/pushes'
+require 'washbullet/api/subscriptions'
 
 module Washbullet
   module API
@@ -9,5 +10,6 @@ module Washbullet
     include Devices
     include Pushes
     include Me
+    include Subscriptions
   end
 end

data/lib/washbullet/api/contacts.rb

@@ -2,11 +2,21 @@ module Washbullet
   module API
     module Contacts
       def contacts
-        get '/v2/contacts'
+        response = get('/v2/contacts')
+
+        Washbullet::Contact.from_response(response)
+      end
+
+      def create_contact
+        raise NotImplementedError
+      end
+
+      def update_contact
+        raise NotImplementedError
       end
 
-      def delete_contact(contact_iden)
-        delete "/v2/contacts/#{contact_iden}"
+      def delete_contact
+        raise NotImplementedError
       end
     end
   end

data/lib/washbullet/api/devices.rb

@@ -2,11 +2,17 @@ module Washbullet
   module API
     module Devices
       def devices
-        get '/v2/devices'
+        response = get('/v2/devices')
+
+        Washbullet::Device.from_response(response)
+      end
+
+      def update_device
+        raise NotImplementedError
       end
 
-      def delete_device(device_iden)
-        delete "/v2/devices/#{device_iden}"
+      def delete_device
+        raise NotImplementedError
       end
     end
   end

data/lib/washbullet/api/me.rb

@@ -2,7 +2,7 @@ module Washbullet
   module API
     module Me
       def me
-        get '/v2/users/me'
+        User.new(get('/v2/users/me').body)
       end
     end
   end

data/lib/washbullet/api/pushes.rb

@@ -1,70 +1,29 @@
+require 'washbullet/pushable'
+require 'washbullet/pushable/file'
+require 'washbullet/pushable/link'
+require 'washbullet/pushable/note'
+
 module Washbullet
   module API
     module Pushes
-      def push_note(device_iden, title, body)
-        push :note, device_iden, title: title, body: body
-      end
-
-      def push_link(device_iden, title, url, body)
-        push :link, device_iden, title: title, url: url, body: body
-      end
-
-      def push_address(device_iden, name, address)
-        push :address, device_iden, name: name, address: address
+      def push_note(receiver: nil, identifier: nil, params: {})
+        Washbullet::Pushable::Note.push(self, receiver, identifier, params)
       end
 
-      def push_list(device_iden, title, items)
-        push :list, device_iden, title: title, items: items
+      def push_link(receiver: nil, identifier: nil, params: {})
+        Washbullet::Pushable::Link.push(self, receiver, identifier, params)
       end
 
-      def push_file(device_iden, file_name, file_path, body)
-        upload_file(file_name, file_path) do |data|
-          payload = {
-            file_name: data['file_name'],
-            file_type: data['file_type'],
-            file_url:  data['file_url'],
-            body:      body
-          }
-
-          push :file, device_iden, payload
-        end
+      def push_file(receiver: nil, identifier: nil, params: {})
+        Washbullet::Pushable::File.push(self, receiver, identifier, params)
       end
 
-      def pushes(modified_after = nil, cursor = nil)
-        params = {modified_after: modified_after, cursor: cursor}
-
-        params = params.values.all?(&:nil?) ? {} : params
-
-        get 'v2/pushes', params
+      def get_pushes(modified_after = nil, cursor = nil)
+        raise NotImplementedError
       end
 
       def delete_push(push_iden)
-        delete "/v2/pushes/#{push_iden}"
-      end
-
-      private
-
-      def upload_file(file_name, file_path, &block)
-        mime_type = MIME::Types.type_for(file_path).first.to_s
-
-        data = upload_request(file_name, mime_type)
-
-        upload_url = data.body['upload_url']
-        payload    = data.body['data']
-
-        io   = Faraday::UploadIO.new(file_path, mime_type)
-
-        post upload_url, payload.merge(file: io)
-
-        yield data.body
-      end
-
-      def upload_request(file_name, mime_type)
-        get '/v2/upload-request', file_name: file_name, file_type: mime_type
-      end
-
-      def push(type, device_iden, payload)
-        post '/v2/pushes', payload.merge(device_iden: device_iden, type: type)
+        raise NotImplementedError
       end
     end
   end

data/lib/washbullet/api/subscriptions.rb

@@ -0,0 +1,17 @@
+module Washbullet
+  module API
+    module Subscriptions
+      def subscriptions
+        response = get('/v2/subscriptions')
+
+        Washbullet::Channel.from_response(response)
+      end
+
+      def channel_info(tag)
+        response = get('/v2/channel-info', tag: tag).body
+
+        Washbullet::Channel.new(response)
+      end
+    end
+  end
+end

data/lib/washbullet/{basic_authentication.rb → authorization.rb}

@@ -1,5 +1,5 @@
 module Washbullet
-  class BasicAuthentication < Faraday::Request::BasicAuthentication
+  class Authorization < Faraday::Request::Authorization
     def call(env)
       if env.url.to_s.match(Washbullet::Client::ENDPOINT)
         env.request_headers[KEY] = @header_value

data/lib/washbullet/channel.rb

@@ -0,0 +1,29 @@
+module Washbullet
+  class Channel
+    attr_reader :body
+
+    def self.from_response(response)
+      response.body['subscriptions'].each_with_object([]) {|attributes, memo|
+        next unless attributes['active']
+
+        memo << new(attributes['channel'])
+      }
+    end
+
+    def initialize(response_body)
+      @body = response_body
+    end
+
+    def name
+      body['name']
+    end
+
+    def description
+      body['description']
+    end
+
+    def identifier
+      body['iden']
+    end
+  end
+end

data/lib/washbullet/client.rb

@@ -2,7 +2,7 @@ require 'faraday'
 require 'mime/types'
 
 require 'washbullet/api'
-require 'washbullet/basic_authentication'
+require 'washbullet/authorization'
 require 'washbullet/http_exception'
 require 'washbullet/parse_json'
 require 'washbullet/request'
@@ -21,33 +21,33 @@ module Washbullet
       @api_key = api_key
     end
 
-    def middleware
-      @middleware ||= Faraday::RackBuilder.new do |f|
-        f.request :multipart
-        f.request :url_encoded
-
-        f.use Washbullet::BasicAuthentication, @api_key, ''
-        f.use Washbullet::ParseJSON
-        f.use Washbullet::HttpException
+    private
 
-        f.adapter :net_http
-      end
+    def connection
+      @connection ||= Faraday.new(ENDPOINT, connection_options)
     end
 
     def connection_options
       @connection_options ||= {
-        :builder => middleware,
-        :headers => {
-          :accept     => 'application/json',
-          :user_agent => "Washbullet Ruby Gem #{Washbullet::VERSION}",
+        builder: middleware,
+        headers: {
+          accept:     'application/json',
+          user_agent: "Washbullet Ruby Gem #{Washbullet::VERSION}"
         }
       }
     end
 
-    private
+    def middleware
+      @middleware ||= Faraday::RackBuilder.new do |f|
+        f.request :multipart
+        f.request :url_encoded
 
-    def connection
-      @connection ||= Faraday.new(ENDPOINT, connection_options)
+        f.use Washbullet::Authorization, 'Bearer', api_key
+        f.use Washbullet::ParseJSON
+        f.use Washbullet::HttpException
+
+        f.adapter :net_http
+      end
     end
   end
 end