cdn77 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bfd78dd2a34718e5ff5b883edc2fc40ae64aa49
+  data.tar.gz: c3b54b15c9afa921baf64d440fb9c1778f8f46e8
+SHA512:
+  metadata.gz: 8cf0f6146103bdab9715d723769f6ac9ff6d6d38854a67f37e2d266b96962b047a60bfb0a2795f59e374f5b21e88b4f89e55a9c7c71fa31152c1be0b4f2f75c0
+  data.tar.gz: 6bb8ccc37bc6ec4908d41ab4bd34b534c7571521dc7fca10eda3bedf0e5fbbdd89654cb60ca73da352eabcee71b093339ff7bdfd0e0b54b589bf938e452adb38

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+
+gemfile:
+  - Gemfile
+
+script: "bundle exec rspec"

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 ТоМесто
+
+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,83 @@
+# cdn77
+
+Wrapper for CDN77 API that allows you to do a wide range of commands and tasks from an external script or server.
+
+## Installation
+
+This gem works with Rails 3.2 onwards. To make it available just add following lines into your Gemfile:
+
+```ruby
+gem "cdn77"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install xxx
+```
+And require in irb:
+
+```ruby
+require "cdn77"
+```
+
+## Using
+
+To perform any requests use simple wrapper:
+
+```ruby
+config = Cdn77::Configuration.new(:login => "someone@example.com", :password => "secret")
+cdn = Cdn77.cdn(config)
+cdn.get("account", "details") 
+# {:status => "ok", :description => "Request was successful.", :account => ...}
+```
+
+If you want to setup configuration only once you should take a look on `Cdn77.configure`. For example, it is a good idea to create initializer with following code in Rails:
+
+```ruby
+# config/initializers/cdn77.rb
+
+Cdn77.configure do |config|
+  config.login = "someone@example.com"
+  config.password = "secret"
+end
+```
+
+Now just call API's method in any part of your application:
+
+```ruby
+Cdn77.cdn.get("account", "details")
+# {:status => "ok", :description => "Request was successful.", :account => ...}
+```
+
+Of course, you can override global configuration if needed. For example:
+
+```ruby
+Cdn77.configure do |config|
+  config.login = "someone@example.com"
+  config.password = "secret"
+end
+Cdn77.cdn.get("account", "details", :login => "someoneelse@example.com", :password => 'elsesecret')
+```
+
+To make requests using HTTP POST call `post` method:
+
+```ruby
+Cdn77.cdn.post("account", "edit", :full_name => "Martin Eden")
+```
+
+ And have fun!
+
+## Contributing
+
+1. Fork it ( https://github.com/ToMesto/cdn77/fork )
+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 a new Pull Request

data/Rakefile

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

data/cdn77.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cdn77/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cdn77"
+  spec.version       = Cdn77::VERSION
+  spec.authors       = ["Sergey Tsvetkov"]
+  spec.email         = ["sergey.a.tsvetkov@gmail.com"]
+  spec.summary       = %q{Wrapper for CDN77 API}
+  spec.description   = %q{CDN77 API allows you to do a wide range of commands and tasks from an external script or server.}
+  spec.homepage      = "https://github.com/ToMesto/cdn77"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "webmock", "~> 1.20"
+end

data/lib/cdn77.rb

@@ -0,0 +1,109 @@
+require "cdn77/version"
+require "uri"
+require "net/http"
+require "net/https"
+require "json"
+
+module Cdn77
+  autoload :Account, "cdn77/account"
+  autoload :Configuration, "cdn77/configuration"
+
+  def self.cdn(configuration = nil)
+    CDN.new(configuration)
+  end
+
+  class MethodCallError < StandardError; end;
+
+  class CDN
+    include Cdn77::Account
+
+    def initialize(configuration = nil)
+      @configuration = configuration
+    end
+
+    def configuration
+      @configuration || Cdn77.configuration
+    end
+
+    def login
+      configuration.login
+    end
+
+    def password
+      configuration.password
+    end
+
+    def headers
+      {
+        "Accept" => "application/json"
+      }
+    end
+
+    def post(scope, method, params = {}, &block)
+      raise_if_invalid(scope, method)
+      uri = URI(url(scope, method))
+      http = Net::HTTP.new(uri.host,uri.port)
+      http.use_ssl = true
+      params = URI.encode_www_form(with_creditinals(params))
+      handle_response(http.post(uri.request_uri, params, headers), &block)
+    end
+
+    def get(scope, method, params = {}, &block)
+      raise_if_invalid(scope, method)
+      uri = URI(url(scope, method, with_creditinals(params)))
+      http = Net::HTTP.new(uri.host,uri.port)
+      http.use_ssl = true
+      handle_response(http.get(uri.request_uri, headers), &block)
+    end
+
+    def url(scope, method, params = {})
+      raise_if_invalid(scope, method)
+      url = configuration.endpoint + "/#{scope}/#{method}"
+      url += "?#{URI.encode_www_form(params)}" if params && params.any?
+      url
+    end
+
+    private
+
+    def handle_response(response)
+      raise MethodCallError, response.body unless response.is_a?(Net::HTTPSuccess)
+      body = response.body
+      raise MethodCallError, "Response could not be empty" if body.nil? || body.empty?
+      json = JSON.parse(body, :symbolize_names => true)
+      if json[:status] == "ok"
+        block_given? ? yield(json) : json
+      else
+        message = [ json[:description].to_s ]
+        message += json[:errors].map { |field, description| "#{field}: #{description}" } if json[:errors]
+        raise MethodCallError, message.join(". ")
+      end
+    end
+
+    def with_creditinals(params = {})
+      params ||= {}
+      params[:passwd] = params.delete(:password) if params[:password] && !params[:passwd]
+      params[:login] ||= login
+      params[:passwd] ||= password
+      params
+    end
+
+    def raise_if_invalid(scope, method)
+      raise ArgumentError, "Scope could not be empty" if scope.nil? || scope.empty?
+      raise ArgumentError, "Method could not be empty" if method.nil? || method.empty?
+      raise ArgumentError, "Configuration endpoint was not specified" if configuration.nil? || configuration.endpoint.nil? || configuration.endpoint.empty? 
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.reset_configuration
+    self.configuration = nil
+  end
+  
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/cdn77/account.rb

@@ -0,0 +1,6 @@
+module Cdn77
+  module Account
+    def details
+    end
+  end
+end

data/lib/cdn77/configuration.rb

@@ -0,0 +1,16 @@
+module Cdn77
+  class Configuration
+    DEFAULT_ENDPOINT = "https://client.cdn77.com/api/v2.0"
+
+    attr_accessor :login
+    attr_accessor :password
+    attr_accessor :endpoint
+
+    def initialize(params = nil)
+      params ||= {}
+      self.login = params[:login]
+      self.password = params[:password]
+      self.endpoint = params[:endpoint] || DEFAULT_ENDPOINT
+    end
+  end
+end

data/lib/cdn77/version.rb

@@ -0,0 +1,3 @@
+module Cdn77
+  VERSION = "0.0.1"
+end

data/spec/account_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Cdn77::Account do
+end

data/spec/cdn_spec.rb

@@ -0,0 +1,135 @@
+require "spec_helper"
+
+shared_examples "an url builder" do |method_name|
+  it "should raise ArgumentError when scope is nil" do
+     expect{ cdn.send(method_name, nil, "details") }.to raise_error(ArgumentError, "Scope could not be empty")
+  end
+
+  it "should raise ArgumentError when method is nil" do
+    expect{ cdn.send(method_name, "account", nil) }.to raise_error(ArgumentError, "Method could not be empty")
+  end
+
+  it "should raise ArgumentError when configuration in not specified" do
+    allow(Cdn77).to receive(:configuration).and_return(nil)
+    expect{ cdn.send(method_name, "account", "details") }.to raise_error(ArgumentError, "Configuration endpoint was not specified")
+  end
+end
+
+shared_examples "a request sender" do |method, url|
+  let (:successful_response_body) do
+    { 
+      :status => "ok", 
+      :description => "Request was successful." 
+    }
+  end
+  
+  let (:wrong_credentials_response_body) do
+    { 
+      :status => "error", 
+      :description => "Authentication failed. Please, login again or contact our support." 
+    }
+  end
+  
+  let (:wrong_parameters_response_body) do
+    {
+      :status => "error", 
+      :description => "Request was not successful.", 
+      :errors => {
+        :email => "email is required.", 
+        :password => "password is required."
+      }
+    }
+  end
+
+  it "should raise MethodCallError when response code is not 200 OK" do
+    stub_request(method, url).to_return(:status => 500, :body => successful_response_body.to_json)
+    expect{ cdn.send(method, "account", "details") }.to raise_error(Cdn77::MethodCallError)
+  end
+
+  it "should raise MethodCallError when response body is empty" do
+    stub_request(method, url).to_return(:status => 500, :body => '')
+    expect{ cdn.send(method, "account", "details") }.to raise_error(Cdn77::MethodCallError)
+  end
+
+  it "should raise MethodCallError when response status is not ok" do
+    stub_request(method, url).to_return(:status => 200, :body => wrong_parameters_response_body.to_json)
+    expect{ cdn.send(method, "account", "details") }.to raise_error(Cdn77::MethodCallError)
+  end
+
+  it "should raise MethodCallError when wrong creditinals reported" do
+    stub_request(method, url).to_return(:status => 200, :body => wrong_credentials_response_body.to_json)
+    expect{ cdn.send(method, "account", "details") }.to raise_error(Cdn77::MethodCallError, wrong_credentials_response_body[:description])
+  end
+
+  it "should return response body as a hash if no block given" do
+    stub_request(method, url).to_return(:status => 200, :body => successful_response_body.to_json)
+    expect(cdn.send(method, "account", "details")).to eq(successful_response_body)
+  end
+
+  it "should pass response body as a hash into given block" do
+    stub_request(method, url).to_return(:status => 200, :body => successful_response_body.to_json)
+    expect{ |block| cdn.send(method, "account", "details", &block) }.to yield_with_args(successful_response_body)
+  end
+
+  it "should send request with login and password in parameters" do
+    stub_request(method, url).to_return(:status => 200, :body => successful_response_body.to_json)
+    cdn.send(method, "account", "details")
+    expect(WebMock).to have_requested(method, url)
+  end
+end
+
+describe Cdn77::CDN do
+  before do
+    Cdn77.configure do |config|
+      config.login = "ivan@examle.com"
+      config.password = "secret"
+    end
+  end
+
+  let (:cdn) { Cdn77.cdn }
+  
+  describe "#configuration" do
+    it "should return global configuration" do
+      expect(Cdn77::configuration.login).to eq("ivan@examle.com")
+      expect(Cdn77::configuration.password).to eq("secret")
+    end
+  end
+
+  describe "#cdn" do
+    it "should use specific configuration if it was provided" do
+      config = Cdn77::Configuration.new(:login => "vasya@example.com", :password => "secretsecret")
+      cdn = Cdn77.cdn(config)
+      expect(cdn.configuration).to eq(config)
+      expect(cdn.login).to eq("vasya@example.com")
+      expect(cdn.password).to eq("secretsecret")
+    end
+  end
+
+  describe "#url" do
+    it { is_expected.to respond_to(:url) }
+    
+    it_behaves_like "an url builder", :url
+
+    it "should return correct url with scope and method" do
+      expect(cdn.url("account", "details")).to eq("https://client.cdn77.com/api/v2.0/account/details")
+    end
+
+    it "should add given params to url" do
+      expect(cdn.url("account", "details", :test => "test")).to eq("https://client.cdn77.com/api/v2.0/account/details?test=test")
+    end
+  end
+
+  describe "#post" do
+    it { is_expected.to respond_to(:post) }
+
+    it_behaves_like "an url builder", :post
+    it_behaves_like "a request sender", :post, "https://client.cdn77.com/api/v2.0/account/details"
+  end
+
+  describe "#get" do
+    it { is_expected.to respond_to(:get) }
+
+    it_behaves_like "an url builder", :get
+    it_behaves_like "a request sender", :get, "https://client.cdn77.com/api/v2.0/account/details?login=ivan@examle.com&passwd=secret"
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe Cdn77::Configuration do
+  it { is_expected.to respond_to(:login, :password, :endpoint) }
+
+  it "should return default endpoint if another was not given" do
+    expect(Cdn77::Configuration.new.endpoint).to eq(Cdn77::Configuration::DEFAULT_ENDPOINT)
+  end
+
+  it "should return provided endpoint" do
+    expect(Cdn77::Configuration.new(:endpoint => "https://exmaple.com").endpoint).to eq("https://exmaple.com")
+  end
+
+  it "should return provided login and password" do
+    config = Cdn77::Configuration.new(:login => "ivan@example.com", :password => "secret")
+    expect(config.login).to eq("ivan@example.com")
+    expect(config.password).to eq("secret")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+
+Bundler.setup
+
+require 'webmock/rspec'
+require 'cdn77'
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks|
+    mocks.verify_doubled_constant_names = true
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: cdn77
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Tsvetkov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: CDN77 API allows you to do a wide range of commands and tasks from an
+  external script or server.
+email:
+- sergey.a.tsvetkov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cdn77.gemspec
+- lib/cdn77.rb
+- lib/cdn77/account.rb
+- lib/cdn77/configuration.rb
+- lib/cdn77/version.rb
+- spec/account_spec.rb
+- spec/cdn_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ToMesto/cdn77
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Wrapper for CDN77 API
+test_files:
+- spec/account_spec.rb
+- spec/cdn_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb