snapcat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e888b4d7abb16b802f4805367bb673590c1220a
+  data.tar.gz: fbb23356c09c30d5544735805a18671afea27ef5
+SHA512:
+  metadata.gz: aa65c119939ce0e0cc1c2fd4ad27f0a8a2d7f021bde43d38f319da5564cb7b37d330ba89309f314032cbf48f3bf364c1c000367d4d9d807536ae7bc5ac18dc2b
+  data.tar.gz: 16f5299266b6dc2087998db38f3a342f3c9b331ef3606579c31523c5360fd3c4147cbdfebf30b3c1315e2ceba7bdb7d6166992f7dadd6fa48bf92e2ba9ea1960

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.config
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Dependencies in gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Neal Kemp
+
+MIT License
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,194 @@
+Snapcat
+=======
+[![Build Status](https://travis-ci.org/NealKemp/snapcat.png)](https://travis-ci.org/NealKemp/snapcat)
+
+
+A cat-tastic Ruby wrapper for the [Snapchat](http://snapchat.com) private API.
+Meow. This gem is designed to give you a friendly Ruby-like interface for
+interacting with the Snapchat API.
+
+
+Installation
+------------
+
+Add this line to your application's `Gemfile`:
+
+    gem 'snapcat', '0.0.1'
+
+And then execute:
+
+    $ bundle
+
+Alternatively, install it via command line:
+
+    $ gem install snapcat
+
+
+Usage
+-----
+
+**User Auth**
+
+```ruby
+# Initialize a client and login
+snapcat = Snapcat::Client.new('your-username')
+snapcat.login('topsecretpassword')
+
+# Initialize a new client, register, and login
+snapcat = Snapcat::Client.new('your-new-username')
+snapcat.register('topsecretpassword', '1990-01-20', 'test@example.com')
+
+# Logout
+snapcat.logout
+```
+
+
+**User Actions**
+
+```ruby
+# Block a user
+snapcat.block('username-to-block')
+
+# Clear feed
+snapcat.clear_feed
+
+# Fetch a user's updates
+snapcat.fetch_updates
+
+# Unblock a user
+snapcat.unblock('username-to-unlock')
+
+# Update user's email
+snapcat.update_email('newemail@example.com')
+
+# Update user's privacy setting
+# Two choices:
+#   Snapcat::User::Privacy::EVERYONE
+#   Snapcat::User::Privacy::FRIENDS
+snapcat.update_privacy(Snapcat::User::Privacy::EVERYONE)
+
+# Pro tip:
+#   Every call to the API responds with Snapcat::Response object with which
+#   you can check a few important things
+response = snapcat.block('username-to-block')
+response.code # => 200
+response.http_success # => true
+response.data # => { logged: true, ... }
+```
+
+**User Data**
+
+```ruby
+# Get the user
+user = snapcat.user
+
+# Examine all raw user data
+user.data
+
+# Examine snaps received
+user.snaps_received
+
+# Examine snaps sent
+user.snaps_sent
+
+# Examine friends
+user.friends
+```
+
+**Friends**
+
+```ruby
+# Grab a friend
+friend = user.friends.first
+
+# Set a friend's display name
+snapcat.set_display_name(friend.username, 'Nik Ro')
+
+# Delete a friend :(
+snapcat.delete_friend(friend.username)
+
+# Learn more about your friend
+friend.can_see_custom_stories
+friend.display_name
+friend.username
+
+# What kind of friend are they anyway??
+friend.type
+friend.type.confirmed?
+friend.type.unconfirmed?
+friend.type.blocked?
+friend.type.deleted?
+```
+
+**Sending Snaps**
+
+```ruby
+# Send it to catsaregreat with 3 seconds duration
+# `data` is a string which can be read directly from an mp4 or jpg
+snapcat.send_media(data, 'catsaregreat')
+
+# Or send it to multiple recipients and override default view_duration
+snapcat.send_media(data, %w(catsaregreat ronnie99), view_duration: 4)
+```
+
+**Received Snaps**
+
+```ruby
+# Grab a snap
+snap = user.snaps_received.first
+
+# Get the snap image or video data
+media_response = snapcat.media_for(snap.id)
+media = media_response.data[:media]
+
+# Learn more about the media
+media.image?
+media.video?
+media.file_extension
+media.type_code
+
+# Get the data from the media object
+media.to_s
+```
+
+**Snaps General**
+
+```ruby
+# Learn more about the snap
+snap.broadcast
+snap.broadcast_action_text
+snap.broadcast_hide_timer
+snap.broadcast_url
+snap.screenshot_count
+snap.media_id
+snap.id
+snap.media_type
+snap.recipient
+snap.sender
+snap.status
+snap.sent
+snap.opened
+```
+
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Add tests and make sure they pass
+6. Create new Pull Request
+
+
+Credits
+-------
+
+* [Neal Kemp](http://nealke.mp)
+* Based on work by martinp on [pysnap](https://github.com/martinp/pysnap) and by
+  djstelles on [php-snapchat](https://github.com/dstelljes/php-snapchat)
+
+Copyright © 2013 Neal Kemp
+
+Released under the MIT License, which can be found in the repository in `LICENSE.txt`.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib', 'spec'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task default: :test

data/lib/snapcat.rb

@@ -0,0 +1,19 @@
+require 'digest'
+require 'httmultiparty'
+require 'json'
+require 'openssl'
+require 'tempfile'
+
+require 'snapcat/client'
+require 'snapcat/crypt'
+require 'snapcat/friend'
+require 'snapcat/media'
+require 'snapcat/requestor'
+require 'snapcat/response'
+require 'snapcat/snap'
+require 'snapcat/snapcat_error'
+require 'snapcat/timestamp'
+require 'snapcat/user'
+
+module Snapcat
+end

data/lib/snapcat/client.rb

@@ -0,0 +1,189 @@
+module Snapcat
+  class Client
+    attr_reader :user
+
+    def initialize(username)
+      @user = User.new
+      @requestor = Requestor.new(username)
+    end
+
+    def block(username)
+      @requestor.request_with_username(
+        'friend',
+        action: 'block',
+        friend: username
+      )
+    end
+
+    def clear_feed
+      @requestor.request_with_username('clear')
+    end
+
+    def fetch_updates(update_timestamp = 0)
+      set_user_data_with(@requestor.request_with_username(
+        'updates',
+        update_timestamp: update_timestamp
+      ))
+    end
+
+    def media_for(snap_id)
+      @requestor.request_media(snap_id)
+    end
+
+    def delete_friend(username)
+      @requestor.request_with_username(
+        'friend',
+        action: 'delete',
+        friend: username
+      )
+    end
+
+    def set_display_name(username, display_name)
+      @requestor.request_with_username(
+        'friend',
+        action: 'display',
+        display: display_name,
+        friend: username
+      )
+    end
+
+    def login(password)
+      set_user_data_with(
+        @requestor.request_with_username('login', password: password)
+      )
+    end
+
+    def logout
+      @requestor.request_with_username('logout')
+    end
+
+    def register(password, birthday, email)
+      result = @requestor.request(
+        'register',
+        birthday: birthday,
+        email: email,
+        password: password
+      )
+      unless result.success?
+        return result
+      end
+
+      result_two = @requestor.request_with_username(
+        'registeru',
+        email: email
+      )
+
+      set_user_data_with(result_two)
+    end
+
+    def screenshot(snap_id, view_duration = 1)
+      raise NotImplementedError
+
+      snap_data = {
+        snap_id => {
+          c: Status::SCREENSHOT,
+          sv: view_duration,
+          t: Timestamp.float
+        }
+      }
+      events = [
+        {
+          eventName: 'SNAP_SCREENSHOT',
+          params: { id: snap_id },
+          ts: Timestamp.macro - view_duration
+        }
+      ]
+
+      request_events(events, snap_data)
+    end
+
+    def send_media(data, recipients, options = {})
+      result = @requestor.request_upload(data, options[:type])
+
+      unless result.success?
+        return result
+      end
+
+      media_id = result.data[:media_id]
+
+      @requestor.request_with_username(
+        'send',
+        media_id: media_id,
+        recipient: prepare_recipients(recipients),
+        time: options[:view_duration] || 3
+      )
+    end
+
+    def unblock(username)
+      @requestor.request_with_username(
+        'friend',
+        action: 'unblock',
+        friend: username
+      )
+    end
+
+    def view(snap_id, view_duration = 1)
+      raise NotImplementedError
+
+      snap_data = {
+        snap_id => { t: Timestamp.float, sv: view_duration }
+      }
+      events = [
+        {
+          eventName: 'SNAP_VIEW',
+          params: { id: snap_id },
+          ts: Timestamp.macro - view_duration
+        },
+        {
+          eventName: 'SNAP_EXPIRED',
+          params: { id: snap_id },
+          ts: Timestamp.macro
+        }
+      ]
+
+      request_events(events, snap_data)
+    end
+
+    def update_email(email)
+      @requestor.request_with_username(
+        'settings',
+        action: 'updateEmail',
+        email: email
+      )
+    end
+
+    def update_privacy(code)
+      @requestor.request_with_username(
+        'settings',
+        action: 'updatePrivacy',
+        privacySetting: code
+      )
+    end
+
+    private
+
+    def prepare_recipients(recipients)
+      if recipients.is_a? Array
+        recipients.join(',')
+      else
+        recipients
+      end
+    end
+
+    def request_events(events, snap_data)
+      @requestor.request_with_username(
+        'update_snaps',
+        events: events,
+        json: snap_data
+      )
+    end
+
+    def set_user_data_with(result)
+      if result.success?
+        @user.data = result.data
+      end
+
+      result
+    end
+  end
+end