lbry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d38161742271e9c0ab2b6d9716d9d655704f483
+  data.tar.gz: 6f8746957b8dc16f4b8e05fe8a65e0c620901dfe
+SHA512:
+  metadata.gz: c53dca994f68e3a6bd0e8b522923ef36b88d3816a736a0ad04f31551335ed45aa868c1c04e23426be421f0681af94fe273eef31e827d3b75ad01d7179fcd81ac
+  data.tar.gz: 59c43cb256d06bafd055b9f542879eaa5ae581adbbbfbb280d5e41e814b330e179ce277523dbe7a11c5b956bb102afcd5a5361c7e7707c94891e6800c4abc2a9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Daniel Dominguez
+
+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,59 @@
+# Lbry
+
+
+LBRY is an open-source protocol providing distribution, discovery, and purchase of digital content (data) via a decentralized network.
+Ruby wrapper for LBRY and LBRYcrd APIs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lbry'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lbry
+
+## Usage
+
+All methods listed on [Lbry API doc](https://lbryio.github.io/lbry) are working here and they have the same name and accept the same arguments, for example to call the method get example from the api doc: `curl 'http://localhost:5279' --data '{"method":"get","params":{"uri":"what"} }'`, here you will need to do this
+```
+client = Lbry::Client.new
+client.get(uri: "what") =>
+ => #<OpenStruct id=nil, jsonrpc="2.0", result=#<OpenStruct blobs_completed=76, blobs_in_stream=76, channel_claim_id=nil, channel_name=nil, claim_id="6769855a9aa43b67086f9ff3c1a5bacb5698a27a", claim_name="what", completed=true, download_directory="/home/r1/Downloads", download_path="/home/r1/Downloads/LBRY100.mp4", file_name="LBRY100.mp4", key="0edc1705489d7a2b2bcad3fea7e5ce92", metadata=#<OpenStruct author="Samuel Bryan", description="What is LBRY? An introduction with Alex Tabarrok", language="en", license="LBRY inc", licenseUrl="", nsfw=false, preview="", thumbnail="https://s3.amazonaws.com/files.lbry.io/logo.png", title="What is LBRY?", version="_0_1_0">, mime_type="video/mp4", nout=0, outpoint="6c71c02c4990ce0590f6888a77ad11f1ae45486f6a4c56d5013954ee8f6356bc:0", points_paid=0.0, sd_hash="d5169241150022f996fa7cd6a9a1c421937276a3275eb912790bd07ba7aec1fac5fd45431d226b8fb402691e79aeb24b", status="completed", stopped=true, stream_hash="9f41e37b1ea706d1b431a65f634b89c5aadefb106280da3661e4d565d47bc938a345755cafb2af807bcfc9fbde3306e3", stream_name="LBRY100.mp4", suggested_file_name="LBRY100.mp4", total_bytes=158433904, txid="6c71c02c4990ce0590f6888a77ad11f1ae45486f6a4c56d5013954ee8f6356bc", written_bytes=158433824>> 
+
+```
+
+Example on how to get a list of claims:
+```
+client = Lbry::Client.new
+response = client.claim_list(name: "lbry")
+claims = response.result.claims # array of claims
+claims.first => #<OpenStruct address="bTzDhXE4vK6fLqU9LSVgrBGYhxuSj8spH8", amount=1.0, claim_id="2c63bcc26eb26d60e91fe99cd972e38bb64b3401", claim_sequence=15, decoded_claim=true, depth=232551, effective_amount=1.0, has_signature=false, height=147432, hex="080110011adc010801129401080410011a0d57686174206973204c4252593f223057686174206973204c4252593f20416e20696e74726f64756374696f6e207769746820416c6578205461626172726f6b2a0c53616d75656c20427279616e32084c42525920696e6338004a2f68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f66696c65732e6c6272792e696f2f6c6f676f2e706e6752005a001a41080110011a30e3bcfb59a97efd76d5ce7533ff9aae8ad565df4b8d10db32b7296b07d2a3fbd41ba99c439cc972b567323fc97132041d2209766964656f2f6d7034", name="lbry", nout=0, permanent_url="lbry#2c63bcc26eb26d60e91fe99cd972e38bb64b3401", supports=[], txid="32b2c71eb1edb47dfa1b9b645c35fa5a4fdc77b4d4eada08d747e21f3f0871a7", valid_at_height=150075, value=#<OpenStruct claimType="streamType", stream=#<OpenStruct metadata=#<OpenStruct author="Samuel Bryan", description="What is LBRY? An introduction with Alex Tabarrok", language="en", license="LBRY inc", licenseUrl="", nsfw=false, preview="", thumbnail="https://s3.amazonaws.com/files.lbry.io/logo.png", title="What is LBRY?", version="_0_1_0">, source=#<OpenStruct contentType="video/mp4", source="e3bcfb59a97efd76d5ce7533ff9aae8ad565df4b8d10db32b7296b07d2a3fbd41ba99c439cc972b567323fc97132041d", sourceType="lbry_sd_hash", version="_0_0_1">, version="_0_0_1">, version="_0_0_1">> 
+```
+
+You can also look under `test/fixtures/[method_name]/ to see how the response looks like.
+
+You can get the list of supported methods [here](https://github.com/dan1d/lbry-api-ruby/blob/master/lib/lbry/client.rb#L6) and the API doc [here](https://lbryio.github.io/lbry), on the original API DOC you can see the list of arguments needed for each method call.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dan1d/lbry.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lbry"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lbry.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lbry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lbry"
+  spec.version       = Lbry::VERSION
+  spec.authors       = ["Daniel Dominguez"]
+  spec.email         = ["danielfromarg@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for LBRY and LBRYcrd APIs}
+  spec.description   = %q{Ruby wrapper for LBRY and LBRYcrd APIs}
+  spec.homepage      = "https://github.com/dan1d/lbry-api-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "httparty"
+  spec.add_development_dependency "pry"
+end

data/lib/lbry.rb

@@ -0,0 +1,10 @@
+require "lbry/version"
+require "lbry/api"
+require "lbry/api_error"
+require "lbry/client"
+
+module Lbry
+  def initialize(auth: {})
+    Client.new(auth: auth)
+  end
+end

data/lib/lbry/api.rb

@@ -0,0 +1,48 @@
+require 'httparty'
+require 'json'
+
+module Lbry
+  class Api
+    include HTTParty
+    attr_accessor :auth, :default_options
+
+    base_uri 'http://localhost:5279'
+    headers 'Content-Type' => 'application/json'
+
+    def parse_response(raw_response)
+      # binding.pry
+      struct = JSON.parse(raw_response.body, object_class: OpenStruct)
+      error = struct.error
+      return struct unless error && error.code && error.message
+      # binding.pry
+      raise Lbry::ApiError.new(error)
+    end
+
+    def initialize(auth: {})
+      @auth = { username: auth["user"], password: auth["password"] }
+      @default_options = {}
+      default_options[:basic_auth] = auth if auth.values.any?
+    end
+
+    def request(http_verb, lbry_command, lbry_params, headers: {})
+      params = { body: { method: lbry_command, params: lbry_params }.to_json }
+      params[:headers] = headers if headers.keys.any?
+      response = self.class.send(http_verb, '', params)
+      parse_response(response)
+    end
+
+    def get(lbry_command, lbry_params = {}, options: {})
+      request(:get, lbry_command, lbry_params)
+    end
+
+    def post(lbry_command, *lbry_params)
+      headers = { "Content-Type" => "application/x-www-form-urlencoded" }
+      request(:post, lbry_command, *lbry_params, headers: headers)
+    end
+
+    def put(lbry_command, lbry_params = {}, options: {})
+      request(:put, lbry_command, lbry_params)
+    end
+    
+  end
+end

data/lib/lbry/api_error.rb

@@ -0,0 +1,12 @@
+
+module Lbry
+  class ApiError < StandardError
+    def initialize(attributes)
+      @error = attributes.error
+      @code = attributes.code
+      @message = attributes.message
+      @data = attributes.data
+      @jsonrpc = attributes.jsonrpc
+    end
+  end
+end

data/lib/lbry/client.rb

@@ -0,0 +1,167 @@
+# @author Daniel Alejandro Dominguez Diaz
+module Lbry
+  class Client
+    attr_reader :client
+    def self.add_support_for(lbry_command, http_verb: :post)
+      define_method(lbry_command) do |*args, &block|
+        client.send(http_verb, lbry_command, *args)
+      end
+    end
+
+    def initialize(auth: {})
+      @client = Api.new(auth)
+    end
+
+    # Announce blobs to the DHT
+    # @overload blob_announce(query)
+    #   @param [Hash] query
+    #   @option query [String] :blob_hash announce a blob, specified by blob_hash
+    #   @option query [String] :stream_hash announce all blobs associated with stream_hash
+    #   @option query [String] :sd_hash announce all blobs associated with sd_hash and the sd_hash itself
+    add_support_for :blob_announce
+
+    # Get blob availability
+    # @overload blob_announce(query)
+    #   @param [Hash] query
+    #   @option query [String] :blob_hash check availability for this blob hash
+    #   @option query [Number] :search_timeout how long to search for peers for the blob in the dht
+    #   @option query [Number] :sd_hash how long to try downloading from a peer
+    add_support_for :blob_availability
+
+    # Delete a blob
+    # @overload blob_delete(query)
+    #   @param [Hash] query
+    #   @option query [String] :blob_hash blob hash of the blob to delete
+    add_support_for :blob_delete
+
+    # Download and return a blob
+    # @overload blob_get(query)
+    #   @param [Hash] query
+    #   @option query [String] :blob_hash :required, blob hash of the blob to get
+    #   @option query [Number] :timeout timeout in number of seconds
+    #   @option query [String] :encoding by default no attempt at decoding is made, can be set to one of the following decoders: 'json'
+    #   @option query [String] :payment_rate_manager if not given the default payment rate manager will be used. supported alternative rate managers: 'only-free'
+    add_support_for :blob_get
+
+    # Returns blob hashes. If not given filters, returns all blobs known by the blob manager
+    # @overload blob_list(query)
+    #   @param [Hash] query
+    #   @option query [Boolean] :needed only return needed blobs
+    #   @option query [Boolean] :finished only return finished blobs
+    #   @option query [String] :uri filter blobs by stream in a uri
+    #   @option query [String] :stream_hash filter blobs by stream hash
+    #   @option query [String] :sd_hash filter blobs by sd hash
+    #   @option query [Number] :page_size results page size
+    #   @option query [Number] :page page of results to return
+    add_support_for :blob_list
+
+    # Returns blob hashes. If not given filters, returns all blobs known by the blob manager
+    # @overload blob_reflect(query)
+    #   @param [Hash] query
+    #   @option query [String] :reflector_server reflector address
+    add_support_for :blob_reflect
+
+    # Reflects all saved blobs
+    # No args
+    add_support_for :blob_reflect_all
+
+    # Returns blob hashes. If not given filters, returns all blobs known by the blob manager
+    # @overload block_show(query)
+    #   @param [Hash] query
+    #   @option query [String] :blockhash :required, hash of the block to look up
+    #   @option query [Number] :height :required, height of the block to look up
+    add_support_for :block_show
+
+    # Export serialized channel signing information for a given certificate claim id
+    # @overload channel_export(query)
+    #   @param [Hash] query
+    #   @option query [String] :claim_id :required, Claim ID to export information about
+    add_support_for :channel_export
+
+    # Import serialized channel signing information (to allow signing new claims to the channel)
+    # @overload channel_import(query)
+    #   @param [Hash] query
+    #   @option query [String] :serialized_certificate_info :required, certificate info
+    add_support_for :channel_import
+
+    # Get certificate claim infos for channels that can be published to
+    # No args
+    add_support_for :channel_list
+
+    # Generate a publisher key and create a new '@' prefixed certificate claim
+    # @overload channel_new(query)
+    #   @param [Hash] query
+    #   @option query [String] :channel_name :required, name of the channel prefixed with '@'
+    #   @option query [Float] :amount :required, bid amount on the channel
+    add_support_for :channel_new
+
+    # Abandon a name and reclaim credits from the claim
+    # @overload claim_abandon(query)
+    #   @param [Hash] query
+    #   @option query [String] :claim_id claim_id of the claim to abandon
+    #   @option query [String] :txid txid of the claim to abandon
+    #   @option query [Number] :nout nout of the claim to abandon
+    add_support_for :claim_abandon
+
+    # List current claims and information about them for a given name
+    # @overload claim_list(query)
+    #   @param [Hash] query
+    #   @option query [String] :name name of the claim to list info about
+    add_support_for :claim_list
+
+    # List current claims and information about them for a given name
+    # @overload claim_list_by_channel(query)
+    #   @param [Hash] query
+    #   @option query [String] :uri required, uri of the channel
+    #   @option query [String] :uris uris of the channel
+    #   @option query [Number] :page which page of results to return where page 1 is the first page, defaults to no pages
+    #   @option query [Number] :page_size number of results in a page, default of 10
+    add_support_for :claim_list_by_channel
+
+    add_support_for :help
+
+    SUPPORTED_METHODS = %w{
+      claim_list_mine
+      claim_new_support
+      claim_renew
+      claim_send_to_address
+      claim_show
+      cli_test_command
+      commands
+      daemon_stop
+      file_delete
+      file_list
+      file_reflect
+      file_set_status
+      get
+      help
+      peer_list
+      peer_ping
+      publish
+      resolve
+      resolve_name
+      routing_table_get
+      settings_get
+      settings_set
+      status
+      stream_availability
+      stream_cost_estimate
+      transaction_list
+      transaction_show
+      utxo_list
+      version
+      wallet_balance
+      wallet_decrypt
+      wallet_encrypt
+      wallet_is_address_mine
+      wallet_list
+      wallet_new_address
+      wallet_prefill_addresses
+      wallet_public_key
+      wallet_send
+      wallet_unlock
+      wallet_unused_address
+    }.each {|q| self.add_support_for q.to_sym }
+
+  end
+end

data/lib/lbry/version.rb

@@ -0,0 +1,3 @@
+module Lbry
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: lbry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Dominguez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for LBRY and LBRYcrd APIs
+email:
+- danielfromarg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lbry.gemspec
+- lib/lbry.rb
+- lib/lbry/api.rb
+- lib/lbry/api_error.rb
+- lib/lbry/client.rb
+- lib/lbry/version.rb
+homepage: https://github.com/dan1d/lbry-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for LBRY and LBRYcrd APIs
+test_files: []