redvine 0.0.2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+/.rspec
+.DS_Store
+/config.yml
+/vcr_cassettes/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redvine.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jay Stakelon
+
+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,45 @@
+# Redvine
+
+A simple Ruby wrapper for the totally unofficial and undocumented [Vine](http://vine.co) API. Everyone loves Vine these days, and [this pretty much sums up why](http://www.youtube.com/watch?v=sdSJ1--kBZ4).
+
+Very heavily inspired by [Vino](https://github.com/tlack/vino), and made possible by the super sleuthing documented on [khakimov.com](http://khakimov.com/blog/2013/03/12/vines-undocumented-api/).
+
+It pretty much goes without saying that this wasn't authorized by Vine or anyone who works at Vine, so don't blame me if you try to use it and Vine gets mad at you. 
+
+## Installation
+
+    gem install redvine
+
+## Usage
+
+    require 'rubygems'
+    require 'redvine'
+
+    client = Redvine.new
+
+    # Connect to Vine with an email and password
+    client.connect(email: 'your@email.com', password: 'your_vine_password')
+
+    # Get your own timeline
+    client.timeline
+
+    # Find videos by tag
+    client.search('cats')
+
+    # Find user profiles by user ID 
+    client.user_profile('908082141764657152')
+
+    # Get a user's timeline by their user ID
+    client.user_timeline('908082141764657152')
+
+    # Get popular and promoted videos
+    client.popular
+    client.promoted
+
+### Things To Do
+
+* Learn more about the API responses and objects
+* Make it easier to access attributes of common objects (videos and users)
+* Include all of the discovered API endpoints
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config.yml_TEMPLATE

@@ -0,0 +1,2 @@
+email: 'your_vine_email@gmail.com'
+password: 'your_vine_password'

data/lib/redvine.rb

@@ -0,0 +1,67 @@
+require 'httparty'
+require 'redvine/version'
+
+class Redvine
+
+  attr_reader :vine_key, :username, :user_id
+
+  @@baseUrl = 'https://api.vineapp.com/'
+  @@deviceToken = 'Redvine'
+  @@userAgent = 'com.vine.iphone/1.01 (unknown, iPhone OS 6.0, iPad, Scale/2.000000) (Redvine)'
+
+  def connect(opts={})
+    validate_connect_args(opts)
+    query = {username: opts[:email], password: opts[:password], deviceToken: @@deviceToken}
+    headers = {'User-Agent' => @@userAgent}
+    response = HTTParty.post(@@baseUrl + 'users/authenticate', {body: query, headers: headers})
+    @vine_key = response.parsed_response['data']['key']
+    @username = response.parsed_response['data']['username']
+    @user_id = response.parsed_response['data']['userId']
+  end
+
+  def search(tag)
+    raise(ArgumentError, 'You must specify a tag') if !tag
+    get_request_data('timelines/tags/' + tag)
+  end
+
+  def popular
+    get_request_data('timelines/popular')
+  end
+
+  def promoted
+    get_request_data('timelines/promoted')
+  end
+
+  def timeline
+    get_request_data('timelines/graph')
+  end
+
+  def user_profile(uid)
+    raise(ArgumentError, 'You must specify a user id') if !uid
+    get_request_data('users/profiles/' + uid, false)
+  end
+
+  def user_timeline(uid)
+    raise(ArgumentError, 'You must specify a user id') if !uid
+    get_request_data('timelines/users/' + uid)
+  end
+
+
+  private
+  def validate_connect_args(opts={})
+    unless opts.has_key?(:email) and opts.has_key?(:email)
+      raise(ArgumentError, 'You must specify both :email and :password')
+    end
+  end
+
+  def session_headers
+    {'User-Agent' => @@userAgent, 'vine-session-id' => @vine_key}
+  end
+
+  def get_request_data(endpoint, records=true)
+    response = HTTParty.get(@@baseUrl + endpoint, {headers: session_headers})
+    records ? response.parsed_response['data']['records'] : response.parsed_response['data']
+  end
+
+end
+

data/lib/redvine/version.rb

@@ -0,0 +1,3 @@
+class Redvine
+  VERSION = "0.0.2"
+end

data/redvine.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redvine/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "redvine"
+  gem.version       = Redvine::VERSION
+  gem.authors       = ["Jay Stakelon"]
+  gem.email         = ["jay@stakelon.com"]
+  gem.description   = %q{A client for the unofficial Vine API.}
+  gem.summary       = gem.description
+  gem.homepage      = "http://github.com/stakes/redvine"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'httparty'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'autotest-standalone'
+end

data/spec/redvine_spec.rb

@@ -0,0 +1,169 @@
+require 'redvine'
+require 'spec_helper'
+require 'vcr_setup'
+
+include Helpers
+
+describe Redvine do
+
+  describe '.connect' do
+
+    it 'should create a new client' do
+      expect(Redvine.new).to respond_to(:connect).with(1).argument
+    end
+
+    it 'should raise an error without a username and password' do
+      client = Redvine.new
+      expect { client.connect() }.to raise_error(ArgumentError)
+    end
+    
+    it 'should connect and return a hash with a :vine_key' do
+      VCR.use_cassette('redvine') do
+        config = get_config()
+        client = Redvine.new
+        client.connect(email: config['email'], password: config['password'])
+        expect(client.vine_key).to be_an_instance_of(String)
+      end
+    end
+
+  end
+
+  describe '.search' do
+
+    it 'should respond to a search method' do
+      VCR.use_cassette('redvine') do
+        client = setup_client()
+        expect(client).to respond_to(:search)
+      end
+    end
+
+    it 'should throw an error without a tag' do
+      VCR.use_cassette('redvine') do
+        client = setup_client()
+        expect{ client.search() }.to raise_error(ArgumentError)
+      end
+    end
+
+    it 'should return a result when searching for a common keyword' do
+      VCR.use_cassette('redvine', :record => :new_episodes) do
+        client = setup_client()
+        vines = client.search('cat')
+        expect(vines.count).to be > 1
+        expect(vines.first.has_key?('videoUrl')).to be_true
+        expect(vines.first.has_key?('avatarUrl')).to be_true
+      end
+    end
+
+  end
+
+  describe '.popular' do
+
+    it 'should respond to a popular method' do
+      expect(Redvine.new).to respond_to(:popular)
+    end
+
+    it 'should return a set of results with VideoUrls' do
+      VCR.use_cassette('redvine', :record => :new_episodes) do
+        client = setup_client()
+        vines = client.popular
+        expect(vines.count).to be > 1
+        expect(vines.first.has_key?('videoUrl')).to be_true
+      end
+    end
+
+  end
+
+
+  describe '.promoted' do
+
+    it 'should respond to a promoted method' do
+      expect(Redvine.new).to respond_to(:promoted)
+    end
+
+    it 'should return a set of results with VideoUrls' do
+      VCR.use_cassette('redvine', :record => :new_episodes) do
+        client = setup_client()
+        vines = client.promoted
+        expect(vines.count).to be > 1
+        expect(vines.first.has_key?('videoUrl')).to be_true
+      end
+    end
+
+  end
+
+  describe '.timeline' do
+
+    it 'should respond to a timeline method' do
+      expect(Redvine.new).to respond_to(:timeline)
+    end
+
+    it 'should return a set of results with VideoUrls' do
+      VCR.use_cassette('redvine', :record => :new_episodes) do
+        client = setup_client()
+        vines = client.timeline
+        expect(vines.count).to be > 1
+        expect(vines.first.has_key?('videoUrl')).to be_true
+      end
+    end
+
+  end
+
+  describe '.user_profile' do
+
+    it 'should respond to a user_profile method' do
+      expect(Redvine.new).to respond_to(:user_profile)
+    end
+
+    it 'should throw an error without a user id' do
+      client = Redvine.new
+      expect { client.user_profile() }.to raise_error(ArgumentError)
+    end
+
+    it 'should return a user profile for the authenticated user' do
+      VCR.use_cassette('redvine', :record => :new_episodes) do
+        client = setup_client()
+        profile = client.user_profile(client.user_id.to_s)
+        expect(profile.has_key?('userId')).to be_true
+        expect(profile.has_key?('username')).to be_true
+        expect(profile.has_key?('avatarUrl')).to be_true
+      end
+    end
+
+    it 'should return a user profile given a valid user id' do
+      VCR.use_cassette('redvine', :record => :new_episodes) do
+        client = setup_client()
+        profile = client.user_profile('914021455983943680')
+        expect(profile.has_key?('userId')).to be_true
+        expect(profile.has_key?('username')).to be_true
+        expect(profile.has_key?('avatarUrl')).to be_true
+      end
+    end
+
+  end
+
+  describe '.user_timeline' do
+
+    it 'should respond to a user_timeline method' do
+      expect(Redvine.new).to respond_to(:user_timeline)
+    end
+
+    it 'should throw an error without a user id' do
+      client = Redvine.new
+      expect { client.user_timeline() }.to raise_error(ArgumentError)
+    end
+
+    it 'should return a set of results with VideoUrls given a valid user id' do
+      VCR.use_cassette('redvine', :record => :new_episodes) do
+        client = setup_client()
+        vines = client.user_timeline('914021455983943680')
+        expect(vines.count).to be > 1
+        expect(vines.first.has_key?('videoUrl')).to be_true
+      end
+    end
+
+  end
+
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+module Helpers
+  def setup_client
+    config = get_config()
+    client = Redvine.new
+    client.connect(email: config['email'], password: config['password'])
+    client
+  end
+
+  def get_config
+    raw_config = File.read('config.yml')
+    config = YAML.load(raw_config)
+  end
+end

data/spec/vcr_setup.rb

@@ -0,0 +1,6 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'vcr_cassettes'
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: redvine
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Jay Stakelon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: autotest-standalone
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A client for the unofficial Vine API.
+email:
+- jay@stakelon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.yml_TEMPLATE
+- lib/redvine.rb
+- lib/redvine/version.rb
+- redvine.gemspec
+- spec/redvine_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_setup.rb
+homepage: http://github.com/stakes/redvine
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A client for the unofficial Vine API.
+test_files:
+- spec/redvine_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_setup.rb