ya-api-direct 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce703501aca78c8a889a4882c95500b2bb419c30
-  data.tar.gz: 2b2be4b799ae9a28908fd44a362635f76e7cd99d
+  metadata.gz: 55bee9a56313eefa9d774f6edc2422328da00766
+  data.tar.gz: 1fb1aa4fe1bee7e0693ada9645a45014ec340488
 SHA512:
-  metadata.gz: 70218a0c73fc096cbee98e6ad145739338cf52e1f6e94143bb8c263f950a8ac781dcef3fdfff1350c57d2e1bb5642cd0c51c8f1df54331efb6875bb1f728fa02
-  data.tar.gz: 7431e2c5e3428697130ad840001c05157813035e4b09465e27ae015f1023ddf5ca069dcbed26e46fec02ccb631ec91757c0f3fd69b6a9412937dc06de6733a63
+  metadata.gz: 52caccd119c78cc82c6c291403426965a365dbc0444839e7ef1c0423ec604097c6253b9c6297140543d8f3102cd7b34282c53ff30aad691d3b33d35dfb45de35
+  data.tar.gz: 29faa276241e4cf1fb55b612ce78283a38b70ac5a7fb9a897ef50a174a9a12a0254d79d11436ac264e8b60d94f358a41441c49ad77a09a5fb16dd9e1e8f09fd6

data/.gitignore

@@ -0,0 +1,55 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+Gemfile.lock
+
+# for Mac
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'jruby-openssl', platforms: :jruby
+gem 'rake'
+gem 'yard'
+
+group :development do
+	# reserved
+end
+
+group :test do
+  gem 'rspec', '>= 2.14'
+  gem 'rubocop', '>= 0.37'
+  gem 'webmock'
+  gem 'yardstick'
+end
+
+gemspec

data/README.md

@@ -1,11 +1,15 @@
-# ya-api-direct
-A Ruby interface to Yandex Direct API
+# Ya::Api::Direct
+A Ruby interface to Yandex Direct API. Supported versions 4, 4 Live, 5.
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ya/api/direct`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'ya-api-direct'
+```ruby
+gem 'ya-api-direct'
+```
 
 And then execute:
 
@@ -13,11 +17,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install ya_direct_api
-
-Test with rake:
-
-    $ rake
+    $ gem install ya-api-direct
 
 ## Usage
 
@@ -34,7 +34,8 @@ request = {
     "TextCampaignFieldNames" => ["BiddingStrategy"]
 }
 
-@direct = Ya::API::Direct::Client.new({ token: Token })
+options = { token: Token }
+@direct = Ya::API::Direct::Client.new(options)
 json = direct.campaigns.get request
 ```
 
@@ -47,6 +48,16 @@ json = direct.v4.GetCampaignsList []
 
 All names of controllers and methods are equal to ones from Direct API help. 4 vs 4 Live is autodetected.
 
+Allowed options:
+* ``token:`` Yandex Direct API token. Required field. 
+* ``app_id:`` Application ID. Isn't required. Used for Yandex stat.
+* ``login:`` Application login. Isn't required. Used for Yandex stat.
+* ``locale:`` One of locales, supported by Yandex API ('en' or 'ru'). By default: 'en'.
+* ``mode:`` Yandex Direct API server to send requests (``:sandbox`` or ``production``). By default: ``:sandbox``.
+* ``cache:`` send caching request after creating the instance.  By default: ``true``.
+* ``api:`` used only to make caching request (:v5 or :v4),  By default: ``:v5``.
+* ``ssl:`` use SSL connection. By default: ``true``.
+
 ## Caching
 
 By default the client class sends request to clients. You can avoid it by turning this option off, like this:
@@ -73,10 +84,16 @@ Units data of last request is stored in ``units_data`` property. There're 3 keys
 * [Yandex Direct API 5 manual](https://tech.yandex.ru/direct/doc/dg/concepts/about-docpage/)
 * [Yandex Direct API 4 and 4 Live manual](https://tech.yandex.ru/direct/doc/dg-v4/concepts/About-docpage/)
 
+## 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
 
-1. Fork it ( http://github.com/rikkimongoose/ya-api-direct/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 new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/rikkimongoose/ya-api-direct. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :spec do
+  Dir.glob('./spec/spec_*.rb').each { |file| require file}
+end
+
+task default: [:spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ya/api/direct"
+
+# 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

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/lib/ya/api/direct.rb

@@ -0,0 +1,3 @@
+require "ya/api/direct/version"
+require "ya/api/direct/client"
+require "ya/api/direct/exception"

data/lib/ya/api/direct/version.rb

@@ -1,49 +1,7 @@
 module Ya
-  module API
+  module Api
     module Direct
-      module Version
-      	module_function
-
-        # @return [Integer]
-        def major
-          0
-        end
-
-        # @return [Integer]
-        def minor
-          2
-        end
-
-        # @return [Integer]
-        def patch
-          0
-        end
-
-        # @return [Integer, NilClass]
-        def pre
-          nil
-        end
-
-        # @return [Hash]
-        def to_h
-          {
-            major: major,
-            minor: minor,
-            patch: patch,
-            pre: pre,
-          }
-        end
-
-        # @return [Array]
-        def to_a
-          [major, minor, patch, pre].compact
-        end
-
-        # @return [String]
-        def to_s
-          to_a.join('.')
-        end
-      end
+      VERSION = "0.2.1"
     end
   end
 end

data/ya-api-direct.gemspec

@@ -1,18 +1,25 @@
 # coding: utf-8
-$:.push File.expand_path("../lib", __FILE__)
-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ya/api/direct/version'
 
 Gem::Specification.new do |s|
   s.name        = 'ya-api-direct'
-  s.version     = '0.0.1'
+  s.version     = Ya::Api::Direct::VERSION
   s.date        = '2016-09-05'
   s.summary     = "Yandex Direct API v5"
   s.description = "Ruby implementation for Yandex Direct API of versions 5, 4 and 4 Live"
-  s.authors     = %w("Alexander Teut")
+  s.authors     = %w("Rikki Mongoose")
   s.email       = 'alexander.a.teut@gmail.com'
-  s.files       = %w(LICENSE README.md ya-api-direct.gemspec) + Dir['lib/ya/api/direct/*.rb']
   s.homepage    = 'http://rubygems.org/gems/ya-api-direct'
   s.license     = 'MIT'
-  s.version     = Ya::API::Direct::Version
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.12"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "minitest", "~> 5.0"
 end

metadata

@@ -1,25 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: ya-api-direct
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
-- '"Alexander'
-- Teut"
+- '"Rikki'
+- Mongoose"
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2016-09-05 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
 description: Ruby implementation for Yandex Direct API of versions 5, 4 and 4 Live
 email: alexander.a.teut@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
 - LICENSE
 - README.md
-- ya-api-direct.gemspec
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ya/api/direct.rb
 - lib/ya/api/direct/client.rb
 - lib/ya/api/direct/constants.rb
 - lib/ya/api/direct/direct_service_base.rb
@@ -29,6 +79,7 @@ files:
 - lib/ya/api/direct/gateway.rb
 - lib/ya/api/direct/url_helper.rb
 - lib/ya/api/direct/version.rb
+- ya-api-direct.gemspec
 homepage: http://rubygems.org/gems/ya-api-direct
 licenses:
 - MIT