btsync_api 0.8.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pascal Jungblut
+
+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,41 @@
+# btsync
+
+A Ruby wrapper for the [BitTorrent Sync API](http://www.bittorrent.com/sync/developers).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'btsync_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install btsync_api
+
+## Usage
+
+Once you started the BitTorrent Sync client as described in the [documentation](http://www.bittorrent.com/sync/developers/api), you can use the wrapper:
+
+```ruby
+options = {host: 'localhost', port: 8888, login: '', password: ''} # default
+api = BtsyncApi::Api.new(options)
+api.get_os # => {"os"=>"mac"}
+
+# pass arguments to the API
+api.add_folder(dir: dirPath, secret: my_secret, selective_sync: 1)
+
+api.remove_folder # raises BtsyncApi::ApiError('Specify all the required parameters for remove_folder')
+```
+*Note:* The error codes from the BitTorrent Sync API are not yet completely consistent, so expect some `NoMethodError` where it should actually be `Btsync::ApiError`.
+
+## 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. Create new Pull Request

data/Rakefile

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

data/btsync.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'btsync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "btsync_api"
+  spec.version       = BtsyncApi::VERSION
+  spec.authors       = ["Pascal Jungblut"]
+  spec.email         = ["mail@pascal-jungblut.com"]
+  spec.description   = %q{Wrapper for the BitTorrent Sync API}
+  spec.summary       = %q{A thin wrapper around the BitTorrent Sync API. It abstracts the request into method calls and returns parsed JSON.}
+  spec.homepage      = "http://github.com/pascalj/btsync"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/btsync/api.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+require 'json'
+
+module BtsyncApi
+  class ApiError < Exception
+    attr_reader :error_code
+    def initialize(error_code)
+      @error_code = error_code
+    end
+  end
+
+  class Api
+    attr_accessor :settings
+
+    def initialize(options = {})
+      self.settings = default_settings.merge(options)
+    end
+
+    def execute(method, options = {})
+      params = {method: method.to_s}
+      params.merge!(options)
+      response = do_request(params)
+      if response['error'] && response['error'] != 0
+        raise BtsyncApi::ApiError.new(response['error']), response['message']
+      end
+      response
+    end
+
+    def method_missing(method, *args, &block)
+      begin
+        if args.count == 1
+          return execute(method, args[0])
+        else
+          return execute(method)
+        end
+      rescue BtsyncApi::ApiError => e
+        if e.error_code != 1 # not found
+          raise e
+        end
+      end
+      super
+    end
+
+  private
+
+    def do_request(params)
+      url = base_url
+      url.query = URI.encode_www_form(params)
+      http = Net::HTTP.new(url.host, url.port)
+      request = Net::HTTP::Get.new(url.request_uri)
+      request.basic_auth(settings[:login], settings[:password])
+      response = http.request(request)
+      JSON.parse(response.body)
+    end
+
+    def base_url
+      URI::HTTP.build(path: '/api', port: settings[:port], host: settings[:host])
+    end
+
+    def default_settings
+      {
+        host: 'localhost',
+        port: 8888,
+        login: '',
+        password: ''
+      }
+    end
+  end
+end

data/lib/btsync/version.rb

@@ -0,0 +1,3 @@
+module BtsyncApi
+  VERSION = "0.8.1"
+end

data/lib/btsync_api.rb

@@ -0,0 +1,3 @@
+module BtsyncApi
+  autoload :Api, 'btsync/api'
+end

data/spec/btsync/api_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require_relative '../../lib/btsync/api.rb'
+
+describe BtsyncApi::Api do
+
+  let(:api) { BtsyncApi::Api.new }
+
+  before(:each) do
+    api.stub(:do_request).and_return({"error" => 0})
+  end
+
+  describe "#initialize" do
+    it "sets a default port and host if none are given" do
+      api.settings[:host].should == 'localhost'
+      api.settings[:port].should == 8888
+    end
+  end
+  
+  describe "#execute" do
+
+    it "calls the API" do
+      api.should_receive(:do_request).and_return({})
+      api.execute('my_method')
+    end
+
+    it "merges the options as additional parameters" do
+      api.should_receive(:do_request).with(method: 'my_method', foo: 'bar', baz: 'foo')
+      api.execute('my_method', foo: 'bar', baz: 'foo')
+    end
+  end
+
+  describe "#method_missing" do
+
+    it "tries to send a missing method to the API" do
+      api.should_receive(:execute).with(:foobar)
+      api.foobar
+    end
+
+    it "hands the parameters over to #execute" do
+      api.should_receive(:execute).with(:foobar, {foo: 'bar', other: 'argument'})
+      api.foobar(foo: 'bar', other: 'argument')
+    end
+
+    it "allows empty options" do
+      expect{
+        api.valid_method
+      }.to_not raise_error
+    end
+
+    it "calls super if the method is not found" do
+      api.should_receive(:do_request).and_return({ "error" => 1, "message" => "Invalid API method name or format." })
+      expect{
+        api.unkown_method
+      }.to raise_error(NoMethodError)
+    end
+
+    it "passes exceptions other than method not found through" do
+      api.should_receive(:do_request).and_return({ "error" => 2, "message" => "Specify all the required parameters for get_files." })
+      expect{
+        api.get_files
+      }.to raise_error(BtsyncApi::ApiError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: btsync_api
+version: !ruby/object:Gem::Version
+  version: 0.8.1
+  prerelease: 
+platform: ruby
+authors:
+- Pascal Jungblut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Wrapper for the BitTorrent Sync API
+email:
+- mail@pascal-jungblut.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- btsync.gemspec
+- lib/btsync/api.rb
+- lib/btsync/version.rb
+- lib/btsync_api.rb
+- spec/btsync/api_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/pascalj/btsync
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: A thin wrapper around the BitTorrent Sync API. It abstracts the request into
+  method calls and returns parsed JSON.
+test_files:
+- spec/btsync/api_spec.rb
+- spec/spec_helper.rb
+has_rdoc: